|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.connector.federation.FederatedRepositorySource
@ThreadSafe public class FederatedRepositorySource
Field Summary | |
---|---|
static String |
DEFAULT_CONFIGURATION_SOURCE_PATH
|
static int |
DEFAULT_RETRY_LIMIT
The default limit is 0 for retrying connection calls to the underlying source. |
Constructor Summary | |
---|---|
FederatedRepositorySource()
Create a new instance of the source, which must still be properly initialized with a repository name . |
|
FederatedRepositorySource(String repositoryName)
Create a new instance of the source with the required repository name and federation service. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
RepositorySourceCapabilities |
getCapabilities()
Get the capabilities for this source. |
String |
getConfigurationSourceName()
Get the name in JNDI of a RepositorySource instance that should be used by the federated
repository as the configuration repository. |
String |
getConfigurationSourcePath()
Get the path in the source that will be subgraph below the /dna:system branch of the repository. |
String |
getConfigurationWorkspaceName()
Set the name of the workspace in the source used by the federated repository as the configuration repository. |
RepositoryConnection |
getConnection()
Get a connection from this source. |
String |
getName()
Get the name for this repository source. |
Object |
getObjectInstance(Object obj,
Name name,
Context nameCtx,
Hashtable<?,?> environment)
|
String |
getPassword()
Get the password that should be used when authenticating and creating connections . |
Reference |
getReference()
|
RepositoryContext |
getRepositoryContext()
|
String |
getRepositoryName()
Get the name of the federated repository. |
int |
getRetryLimit()
Get the maximum number of retries that may be performed on a given operation when using connections created by this source. |
String |
getSecurityDomain()
Get the name of the security domain that should be used by JAAS to identify the application or security context. |
String |
getUsername()
Get the username that should be used when authenticating and creating connections . |
int |
hashCode()
|
void |
initialize(RepositoryContext context)
Initialize this source to use the supplied RepositoryContext , from which this source can obtain
connections to other sources as well as
execution contexts . |
void |
setConfigurationSourceName(String sourceName)
Get the name of a RepositorySource instance that should be used by the federated
repository as the configuration repository. |
void |
setConfigurationSourcePath(String pathInSourceToConfigurationRoot)
Set the path in the source that will be subgraph below the /dna:system branch of the repository. |
void |
setConfigurationWorkspaceName(String workspaceName)
Set the name of the workspace in the source used by the federated repository as the configuration repository. |
void |
setName(String sourceName)
Set the name of this source. |
void |
setPassword(String password)
Get the password that should be used when authenticating and creating connections . |
void |
setRepositoryName(String repositoryName)
Get the name of the federated repository. |
void |
setRetryLimit(int limit)
Set the maximum number of retries that may be performed on a given operation when using connections created by this source. |
void |
setSecurityDomain(String securityDomain)
Set the name of the security domain that should be used by JAAS to identify the application or security context. |
void |
setUsername(String username)
Set the username that should be used when authenticating and creating connections . |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_RETRY_LIMIT
connection
calls to the underlying source.
public static final String DEFAULT_CONFIGURATION_SOURCE_PATH
Constructor Detail |
---|
public FederatedRepositorySource()
repository name
.
public FederatedRepositorySource(String repositoryName)
repositoryName
- the repository name
IllegalArgumentException
- if the federation service is null or the repository name is null or blankMethod Detail |
---|
public void initialize(RepositoryContext context) throws RepositorySourceException
RepositoryContext
, from which this source can obtain
connections
to other sources
as well as
execution contexts
.
initialize
in interface RepositorySource
RepositorySourceException
RepositorySource.initialize(org.jboss.dna.graph.connector.RepositoryContext)
public RepositoryContext getRepositoryContext()
public String getName()
getName
in interface RepositorySource
public void setName(String sourceName)
This is a required property.
sourceName
- the name of this repository sourcesetConfigurationSourceName(String)
,
setConfigurationSourcePath(String)
,
setPassword(String)
,
setUsername(String)
,
setRepositoryName(String)
,
setPassword(String)
,
setUsername(String)
,
setName(String)
public int getRetryLimit()
connections
created by this source. This value does not constitute a minimum number of retries; in fact, the connection
user is not required to retry any operations.
getRetryLimit
in interface RepositorySource
RepositorySource.getRetryLimit()
public void setRetryLimit(int limit)
connections
created by this source. This value does not constitute a minimum number of retries; in fact, the connection
user is not required to retry any operations.
setRetryLimit
in interface RepositorySource
limit
- the maximum number of allowable retries, or 0 if the source has no limitRepositorySource.setRetryLimit(int)
public String getConfigurationSourceName()
RepositorySource
instance that should be used by the federated
repository
as the configuration repository.
This is a required property.
RepositorySource
instance that should be used for the configuration, or null if the
federated repository instance is to be found in JNDIsetConfigurationSourceName(String)
public void setConfigurationSourceName(String sourceName)
RepositorySource
instance that should be used by the federated
repository
as the configuration repository. The instance will be retrieved from the RepositoryConnectionFactory
instance from the repository context
supplied during
initialization
.
This is a required property.
sourceName
- the name of the RepositorySource
instance that should be used for the configuration, or null if
the federated repository instance is to be found in JNDIgetConfigurationSourceName()
,
setConfigurationSourcePath(String)
,
setPassword(String)
,
setUsername(String)
,
setRepositoryName(String)
,
setName(String)
public String getConfigurationWorkspaceName()
source
used by the federated repository
as the configuration repository. If this workspace name is null, the default workspace as defined by
that source will be used.
configuration source
should be usedpublic void setConfigurationWorkspaceName(String workspaceName)
source
used by the federated repository
as the configuration repository. If this workspace name is null, the default workspace as defined by
that source will be used.
workspaceName
- the name of the configuration workspace, or null if the default workspace for the
configuration source
should be usedpublic String getConfigurationSourcePath()
/dna:system
branch of the repository.
This is a required property.
setConfigurationSourcePath(String)
public void setConfigurationSourcePath(String pathInSourceToConfigurationRoot)
/dna:system
branch of the repository.
This is a required property.
pathInSourceToConfigurationRoot
- the path within the configuration source to the node that should be the root of the
configuration information, or null if the path hasn't yet been set or if the federated repository instance is to be
found in JNDIsetConfigurationSourcePath(String)
,
setConfigurationSourceName(String)
,
setPassword(String)
,
setUsername(String)
,
setRepositoryName(String)
,
setName(String)
public String getSecurityDomain()
public void setSecurityDomain(String securityDomain)
securityDomain
- Sets securityDomain to the specified value.public String getRepositoryName()
This is a required property.
setRepositoryName(String)
public void setRepositoryName(String repositoryName)
This is a required property.
repositoryName
- the new name of the repository
IllegalArgumentException
- if the repository name is null, empty or blankgetRepositoryName()
,
setConfigurationSourceName(String)
,
setConfigurationSourcePath(String)
,
setPassword(String)
,
setUsername(String)
,
setName(String)
public String getUsername()
creating connections
.
This is an optional property, required only when authentication is to be used.
setUsername(String)
public void setUsername(String username)
creating connections
.
This is an optional property, required only when authentication is to be used.
username
- the username, or null if no username has been set or are not to be usedgetUsername()
,
setPassword(String)
,
setConfigurationSourceName(String)
,
setConfigurationSourcePath(String)
,
setPassword(String)
,
setRepositoryName(String)
,
setName(String)
public String getPassword()
creating connections
.
This is an optional property, required only when authentication is to be used.
setPassword(String)
public void setPassword(String password)
creating connections
.
This is an optional property, required only when authentication is to be used.
password
- the password, or null if no password have been set or are not to be usedgetPassword()
,
setConfigurationSourceName(String)
,
setConfigurationSourcePath(String)
,
setUsername(String)
,
setRepositoryName(String)
,
setName(String)
public RepositoryConnection getConnection() throws RepositorySourceException
getConnection
in interface RepositorySource
RepositorySourceException
- if there is a problem obtaining a connectionRepositorySource.getConnection()
public Reference getReference()
getReference
in interface Referenceable
public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment) throws Exception
getObjectInstance
in interface ObjectFactory
Exception
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
public RepositorySourceCapabilities getCapabilities()
getCapabilities
in interface RepositorySource
RepositorySource.getCapabilities()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |