|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.cache.loader.AbstractCacheLoader org.jboss.cache.loader.ClusteredCacheLoader
@ThreadSafe public class ClusteredCacheLoader
A cache loader that consults other members in the cluster for values. Does
not propagate update methods since replication should take care of this. A
timeout
property is required, a long
that
specifies in milliseconds how long to wait for results before returning a
null.
Field Summary |
---|
Fields inherited from class org.jboss.cache.loader.AbstractCacheLoader |
---|
cache, regionManager, transactions |
Constructor Summary | |
---|---|
ClusteredCacheLoader()
|
Method Summary | |
---|---|
void |
commit(java.lang.Object tx)
Does nothing. |
boolean |
exists(Fqn name)
Returns true if the CacheLoader has a node with a Fqn . |
java.util.Map |
get(Fqn name)
Returns all keys and values from the persistent store, given a Fqn |
protected java.util.Map |
get0(Fqn name)
|
java.util.Set |
getChildrenNames(Fqn fqn)
Returns a set of children node names. |
CacheLoaderConfig.IndividualCacheLoaderConfig |
getConfig()
Gets the configuration. |
void |
loadEntireState(java.io.ObjectOutputStream os)
Fetches the entire state for this cache from secondary storage (disk, database) and writes it to a provided ObjectOutputStream. |
void |
loadState(Fqn subtree,
java.io.ObjectOutputStream os)
Fetches a portion of the state for this cache from secondary storage (disk, database) and writes it to a provided ObjectOutputStream. |
void |
prepare(java.lang.Object tx,
java.util.List modifications,
boolean one_phase)
Does nothing. |
void |
put(Fqn name,
java.util.Map attributes)
Does nothing; replication handles put. |
java.lang.Object |
put(Fqn name,
java.lang.Object key,
java.lang.Object value)
Puts a key and value into the attribute map of a given node. |
void |
put(java.util.List<Modification> modifications)
Does nothing; replication handles put. |
void |
remove(Fqn name)
Does nothing; replication handles removal. |
java.lang.Object |
remove(Fqn name,
java.lang.Object key)
Fetches the remove value, does not remove. |
void |
removeData(Fqn name)
Does nothing; replication handles removal. |
void |
rollback(java.lang.Object tx)
Does nothing. |
void |
setConfig(CacheLoaderConfig.IndividualCacheLoaderConfig base)
Sets the configuration. |
void |
setRegionManager(RegionManager manager)
Sets the RegionManager this object should use to manage
marshalling/unmarshalling of different regions using different
classloaders. |
void |
storeEntireState(java.io.ObjectInputStream is)
Stores the entire state for this cache by reading it from a provided ObjectInputStream. |
void |
storeState(Fqn subtree,
java.io.ObjectInputStream is)
Stores the given portion of the cache tree's state in secondary storage. |
Methods inherited from class org.jboss.cache.loader.AbstractCacheLoader |
---|
create, destroy, getMarshaller, getNodeDataList, loadStateHelper, put, setCache, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClusteredCacheLoader()
Method Detail |
---|
public void setConfig(CacheLoaderConfig.IndividualCacheLoaderConfig base)
timeout
is used as the timeout value.
base
- May be an instance of the CacheLoaderConfig.IndividualCacheLoaderConfig
base
class, in which case the cache loader should use the
CacheLoaderConfig.IndividualCacheLoaderConfig.getProperties()
method to find configuration information. Alternatively,
may be a type-specific subclass of CacheLoaderConfig.IndividualCacheLoaderConfig
,
if there is one.public CacheLoaderConfig.IndividualCacheLoaderConfig getConfig()
CacheLoader
CacheLoaderConfig.IndividualCacheLoaderConfig
object.public java.util.Set getChildrenNames(Fqn fqn) throws java.lang.Exception
CacheLoader
Fqn
.
Returns null if the named node is not found or there are no children.
The returned set must not be modifiable. Implementors can use
Collections.unmodifiableSet(java.util.Set)
to make the set unmodifiable.
Implementors may impose restrictions on the contents of an Fqn (such as Strings-only) and as such, indirectly
impose the same restriction on the contents of a Set returned by getChildrenNames().
fqn
- The Fqn
of the parent
java.lang.Exception
public java.util.Map get(Fqn name) throws java.lang.Exception
CacheLoader
Fqn
name
- the Fqn
to search for.
protected java.util.Map get0(Fqn name) throws java.lang.Exception
java.lang.Exception
public boolean exists(Fqn name) throws java.lang.Exception
CacheLoader
Fqn
.
java.lang.Exception
public java.lang.Object put(Fqn name, java.lang.Object key, java.lang.Object value) throws java.lang.Exception
CacheLoader
java.lang.Exception
public void put(Fqn name, java.util.Map attributes) throws java.lang.Exception
name
- The fully qualified name of the nodeattributes
- A Map of attributes. Can be null
java.lang.Exception
public void put(java.util.List<Modification> modifications) throws java.lang.Exception
put
in interface CacheLoader
put
in class AbstractCacheLoader
modifications
- A Listjava.lang.Exception
public java.lang.Object remove(Fqn name, java.lang.Object key) throws java.lang.Exception
java.lang.Exception
public void remove(Fqn name) throws java.lang.Exception
name
- the Fqn
of the node
java.lang.Exception
public void removeData(Fqn name) throws java.lang.Exception
name
- the Fqn
of the node
java.lang.Exception
public void prepare(java.lang.Object tx, java.util.List modifications, boolean one_phase) throws java.lang.Exception
prepare
in interface CacheLoader
prepare
in class AbstractCacheLoader
tx
- The transaction, indended to be used by implementations as an identifier of the transaction (and not necessarily a JTA Transaction
object)modifications
- A List
containing Modification
s, for the given transactionone_phase
- Persist immediately and (for example) commit the local JDBC transaction as well. When true,
we won't get a CacheLoader.commit(Object)
or CacheLoader.rollback(Object)
method call later
java.lang.Exception
public void commit(java.lang.Object tx) throws java.lang.Exception
commit
in interface CacheLoader
commit
in class AbstractCacheLoader
tx
- transaction to commit
java.lang.Exception
public void rollback(java.lang.Object tx)
rollback
in interface CacheLoader
rollback
in class AbstractCacheLoader
tx
- transaction to roll backpublic void loadEntireState(java.io.ObjectOutputStream os) throws java.lang.Exception
CacheLoader
CacheLoader.storeEntireState(ObjectInputStream)
Implementations of this method should not catch any exception or close the
given ObjectOutputStream parameter. In order to ensure cacheloader interoperability
contents of the cache are written to the ObjectOutputStream as a sequence of
NodeData objects.
Default implementation is provided by AbstractCacheLoader
and ensures cacheloader
interoperability. Implementors are encouraged to consider extending AbstractCacheLoader
prior to implementing completely custom cacheloader.
loadEntireState
in interface CacheLoader
loadEntireState
in class AbstractCacheLoader
os
- ObjectOutputStream to write state
java.lang.Exception
AbstractCacheLoader.loadEntireState(ObjectOutputStream)
,
NodeData
public void loadState(Fqn subtree, java.io.ObjectOutputStream os) throws java.lang.Exception
CacheLoader
CacheLoader.storeState(Fqn,ObjectInputStream)
.
Implementations of this method should not catch any exception or close the
given ObjectOutputStream parameter. In order to ensure cacheloader interoperability
contents of the cache are written to the ObjectOutputStream as a sequence of
NodeData objects.
Default implementation is provided by AbstractCacheLoader
and ensures cacheloader
interoperability. Implementors are encouraged to consider extending AbstractCacheLoader
prior to implementing completely custom cacheloader.
loadState
in interface CacheLoader
loadState
in class AbstractCacheLoader
subtree
- Fqn naming the root (i.e. highest level parent) node of
the subtree for which state is requested.os
- ObjectOutputStream to write state
java.lang.Exception
AbstractCacheLoader.loadState(Fqn,ObjectOutputStream)
,
Region.activate()
,
NodeData
public void storeEntireState(java.io.ObjectInputStream is) throws java.lang.Exception
CacheLoader
CacheLoader.loadEntireState(ObjectOutputStream)
}
on some other cache instance. State currently in storage gets overwritten.
Implementations of this method should not catch any exception or close the
given ObjectInputStream parameter. In order to ensure cacheloader interoperability
contents of the cache are read from the ObjectInputStream as a sequence of
NodeData objects.
Default implementation is provided by AbstractCacheLoader
and ensures cacheloader
interoperability. Implementors are encouraged to consider extending AbstractCacheLoader
prior to implementing completely custom cacheloader.
storeEntireState
in interface CacheLoader
storeEntireState
in class AbstractCacheLoader
is
- ObjectInputStream to read state
java.lang.Exception
AbstractCacheLoader.storeEntireState(ObjectInputStream)
,
NodeData
public void storeState(Fqn subtree, java.io.ObjectInputStream is) throws java.lang.Exception
CacheLoader
subtree
,
then no special behavior is required. Otherwise, ensure that
the state is integrated under the given subtree
. Typically
in the latter case subtree
would be the Fqn of the buddy
backup region for
a buddy group; e.g.
If the the transferred state had Fqns starting with "/a" and
subtree
was "/_BUDDY_BACKUP_/192.168.1.2:5555" then the
state should be stored in the local persistent store under
"/_BUDDY_BACKUP_/192.168.1.2:5555/a"
Implementations of this method should not catch any exception or close the
given ObjectInputStream parameter. In order to ensure cacheloader interoperability
contents of the cache are read from the ObjectInputStream as a sequence of
NodeData objects.
Default implementation is provided by AbstractCacheLoader
and ensures cacheloader
interoperability. Implementors are encouraged to consider extending AbstractCacheLoader
prior to implementing completely custom cacheloader.
storeState
in interface CacheLoader
storeState
in class AbstractCacheLoader
subtree
- Fqn naming the root (i.e. highest level parent) node of
the subtree included in state
. If the Fqns
of the data included in state
are not
already children of subtree
, then their
Fqns should be altered to make them children of
subtree
before they are persisted.is
- ObjectInputStream to read state
java.lang.Exception
AbstractCacheLoader.storeState(Fqn,ObjectInputStream)
,
NodeData
public void setRegionManager(RegionManager manager)
CacheLoader
RegionManager
this object should use to manage
marshalling/unmarshalling of different regions using different
classloaders.
NOTE: This method is only intended to be used
by the CacheSPI
instance this cache loader is
associated with.
setRegionManager
in interface CacheLoader
setRegionManager
in class AbstractCacheLoader
manager
- the region manager to use, or null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |