|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.connector.infinispan.InfinispanSource
@ThreadSafe public class InfinispanSource
A repository source that uses an Infinispan instance to manage the content. This source is capable of using an existing
CacheManager
or creating a new cache manager. This process is controlled entirely by the JavaBean properties of the
InfinispanSource instance.
This source first attempts to find an existing cache manager found in JNDI
(or the
DefaultCacheManager
if no such manager is available) and the cache configuration
name
if supplied or the default configuration if not set.
Like other RepositorySource
classes, instances of JBossCacheSource can be placed into JNDI and do support the creation
of JNDI referenceable
objects and resolution of references into JBossCacheSource.
Field Summary | |
---|---|
static String |
DEFAULT_NAME_OF_DEFAULT_WORKSPACE
The initial name of the default workspace is ""default" ", unless otherwise specified. |
static int |
DEFAULT_RETRY_LIMIT
The default limit is 0 for retrying connection calls to the underlying source. |
Constructor Summary | |
---|---|
InfinispanSource()
Create a repository source instance. |
Method Summary | |
---|---|
void |
close()
Signal this source that it is no longer needed and should begin the process of reclaiming or closing all resources that it has acquired. |
boolean |
equals(Object obj)
|
String |
getCacheConfigurationName()
Get the name of the configuration that should be used if a cache is to be created using the
CacheManager found in JNDI or the DefaultCacheManager if needed. |
String |
getCacheManagerJndiName()
Get the name in JNDI of a CacheManager instance that should be used to create the cache for this source. |
RepositorySourceCapabilities |
getCapabilities()
Get the capabilities for this source. |
RepositoryConnection |
getConnection()
Get a connection from this source. |
CachePolicy |
getDefaultCachePolicy()
Get the default cache policy for this source, or null if the global default cache policy should be used |
String |
getDefaultWorkspaceName()
Get the name of the default workspace. |
String |
getName()
Get the name for this repository source. |
Object |
getObjectInstance(Object obj,
Name name,
Context nameCtx,
Hashtable<?,?> environment)
|
String[] |
getPredefinedWorkspaceNames()
Gets the names of the workspaces that are available when this source is created. |
Reference |
getReference()
|
RepositoryContext |
getRepositoryContext()
Returns the repository context for the repository source |
int |
getRetryLimit()
Get the maximum number of retries that may be performed on a given operation when using connections created by this source. |
String |
getRootNodeUuid()
Get the UUID of the root node for the cache. |
UUID |
getRootNodeUuidObject()
Get the UUID of the root node for the cache. |
void |
initialize(RepositoryContext context)
Initialize this source to use the supplied RepositoryContext , from which this source can obtain the
configuration defining this source,
connections to other sources , and the
execution context . |
boolean |
isCreatingWorkspacesAllowed()
Get whether this source allows workspaces to be created dynamically. |
void |
setCacheConfigurationName(String cacheConfigurationName)
Get the name of the configuration that should be used if a cache is to be created using the
CacheManager found in JNDI or the DefaultCacheManager if needed. |
void |
setCacheManagerJndiName(String jndiName)
Set the name in JNDI of a CacheManager instance that should be used to obtain the Cache instance used by
this source. |
void |
setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation)
Set whether this source allows workspaces to be created dynamically. |
void |
setDefaultCachePolicy(CachePolicy defaultCachePolicy)
|
void |
setDefaultWorkspaceName(String nameOfDefaultWorkspace)
Set the name of the workspace that should be used when clients don't specify a workspace. |
void |
setName(String name)
Set the name of this source |
void |
setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames)
Sets the names of the workspaces that are available when this source is created. |
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 |
setRootNodeUuid(String rootNodeUuid)
Set the UUID of the root node in this repository. |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, 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_NAME_OF_DEFAULT_WORKSPACE
name of the default workspace
is ""default" ", unless otherwise specified.
Constructor Detail |
---|
public InfinispanSource()
Method Detail |
---|
public void initialize(RepositoryContext context) throws RepositorySourceException
RepositoryContext
, from which this source can obtain the
configuration
defining this source,
connections
to other sources
, and the
execution context
.
This method may be called each time the configuration changes, allowing the source to update itself.
initialize
in interface RepositorySource
RepositorySourceException
RepositorySource.initialize(org.jboss.dna.graph.connector.RepositoryContext)
public String getName()
getName
in interface RepositorySource
public RepositorySourceCapabilities getCapabilities()
getCapabilities
in interface RepositorySource
RepositorySource.getCapabilities()
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 void setName(String name)
name
- the name for this sourcepublic CachePolicy getDefaultCachePolicy()
getDefaultCachePolicy
in interface MapRepositorySource
public void setDefaultCachePolicy(CachePolicy defaultCachePolicy)
defaultCachePolicy
- Sets defaultCachePolicy to the specified value.public String getCacheManagerJndiName()
CacheManager
instance that should be used to create the cache for this source.
This source first attempts to find a cache instance using the CacheManager
found in
JNDI
(or the DefaultCacheManager
if no such manager is available) and the
cache configuration name
if supplied or the default configuration if not set.
CacheManager
instance that should be used, or null if the DefaultCacheManager
should be used if a cache is to be createdsetCacheManagerJndiName(String)
,
getCacheConfigurationName()
public void setCacheManagerJndiName(String jndiName)
CacheManager
instance that should be used to obtain the Cache
instance used by
this source.
This source first attempts to find a cache instance using the CacheManager
found in
JNDI
(or the DefaultCacheManager
if no such manager is available) and the
cache configuration name
if supplied or the default configuration if not set.
jndiName
- the JNDI name of the CacheManager
instance that should be used, or null if the
DefaultCacheManager
should be used if a cache is to be createdsetCacheManagerJndiName(String)
,
getCacheConfigurationName()
public String getCacheConfigurationName()
cache
is to be created using the
CacheManager
found in JNDI or the DefaultCacheManager
if needed.
This source first attempts to find a cache instance using the CacheManager
found in
JNDI
(or the DefaultCacheManager
if no such manager is available) and the
cache configuration name
if supplied or the default configuration if not set.
CacheManager
, or null if the default
configuration should be usedsetCacheConfigurationName(String)
,
getCacheManagerJndiName()
public void setCacheConfigurationName(String cacheConfigurationName)
cache
is to be created using the
CacheManager
found in JNDI or the DefaultCacheManager
if needed.
This source first attempts to find a cache instance using the CacheManager
found in
JNDI
(or the DefaultCacheManager
if no such manager is available) and the
cache configuration name
if supplied or the default configuration if not set.
cacheConfigurationName
- the name of the configuration that should be passed to the CacheManager
, or null if
the default configuration should be usedgetCacheConfigurationName()
,
getCacheManagerJndiName()
public String getRootNodeUuid()
public UUID getRootNodeUuidObject()
public void setRootNodeUuid(String rootNodeUuid)
rootNodeUuid
- the UUID of the root node for the cache, or null if the UUID should be randomly generatedpublic String getDefaultWorkspaceName()
public void setDefaultWorkspaceName(String nameOfDefaultWorkspace)
nameOfDefaultWorkspace
- the name of the workspace that should be used by default, or null if the
default name
should be usedpublic String[] getPredefinedWorkspaceNames()
setPredefinedWorkspaceNames(String[])
,
setCreatingWorkspacesAllowed(boolean)
public void setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames)
predefinedWorkspaceNames
- the names of the workspaces that this source should start with, or null if there are no
such workspacessetCreatingWorkspacesAllowed(boolean)
,
getPredefinedWorkspaceNames()
public boolean isCreatingWorkspacesAllowed()
set of workspaces
is fixedsetPredefinedWorkspaceNames(String[])
,
getPredefinedWorkspaceNames()
,
setCreatingWorkspacesAllowed(boolean)
public void setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation)
allowWorkspaceCreation
- true if this source allows workspaces to be created by clients, or false if the
set of workspaces
is fixedsetPredefinedWorkspaceNames(String[])
,
getPredefinedWorkspaceNames()
,
isCreatingWorkspacesAllowed()
public RepositoryConnection getConnection() throws RepositorySourceException
getConnection
in interface RepositorySource
RepositorySourceException
- if there is a problem obtaining a connectionRepositorySource.getConnection()
public void close()
connections
may still be in use, this method may not necessarily close all
resources immediately.
This is a required method, and must be called when this source is no longer needed if one or more connections
have been obtained since the previous call to this method.
Note that calling this method also does not preclude obtaining more connections
after this method
is called. If that happens, this source should simply reacquire any resources necessary to provide additional connections,
and this method needs to be called once again.
close
in interface RepositorySource
RepositorySource.close()
public RepositoryContext getRepositoryContext()
MapRepositorySource
repository context
for the repository source
getRepositoryContext
in interface MapRepositorySource
public boolean equals(Object obj)
equals
in class Object
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |