|
||||||||||
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.AbstractDelegatingCacheLoader org.jboss.cache.loader.ReadOnlyDelegatingCacheLoader
public class ReadOnlyDelegatingCacheLoader
Provides ignoreModifications features to all cache loaders.
Field Summary |
---|
Fields inherited from class org.jboss.cache.loader.AbstractCacheLoader |
---|
buddyFqnTransformer, cache, regionManager, transactions |
Constructor Summary | |
---|---|
ReadOnlyDelegatingCacheLoader(CacheLoader cl)
|
Method Summary | |
---|---|
void |
commit(Object tx)
Commits the transaction. |
void |
prepare(Object tx,
List<Modification> modifications,
boolean one_phase)
Prepares a list of modifications. |
void |
put(Fqn name,
Map attributes)
Puts all entries of the map into the existing map of the given node, overwriting existing keys, but not clearing the existing map before insertion. |
Object |
put(Fqn name,
Object key,
Object value)
Puts a key and value into the attribute map of a given node. |
void |
put(List<Modification> modifications)
Applies all modifications to the backend store. |
void |
remove(Fqn fqn)
Removes the given node and all its subnodes, does nothing if the node does not exist. |
Object |
remove(Fqn fqn,
Object key)
Removes the given key and value from the attributes of the given node. |
void |
removeData(Fqn fqn)
Removes all attributes from a given node, but doesn't delete the node itself or any subnodes. |
void |
rollback(Object tx)
Rolls the transaction back. |
void |
storeEntireState(ObjectInputStream is)
Stores the entire state for this cache by reading it from a provided ObjectInputStream. |
void |
storeState(Fqn subtree,
ObjectInputStream is)
Stores the given portion of the cache tree's state in secondary storage. |
Methods inherited from class org.jboss.cache.loader.AbstractDelegatingCacheLoader |
---|
create, destroy, exists, get, getCacheLoader, getChildrenNames, getConfig, loadEntireState, loadState, setCache, setCacheLoader, setConfig, setRegionManager, start, stop |
Methods inherited from class org.jboss.cache.loader.AbstractCacheLoader |
---|
doMarshall, doUnmarshall, getMarshaller, getNodeDataList, loadStateHelper, move, put, regionAwareMarshall, regionAwareUnmarshall, storeStateHelper |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReadOnlyDelegatingCacheLoader(CacheLoader cl)
Method Detail |
---|
public Object put(Fqn name, Object key, Object value) throws Exception
CacheLoader
put
in interface CacheLoader
put
in class AbstractDelegatingCacheLoader
Exception
public void put(Fqn name, Map attributes) throws Exception
CacheLoader
Map.putAll(java.util.Map extends K, ? extends V>)
.
If the node does not exist, all parent nodes from the root down are created automatically
Note since 3.0, as an optimization, this method will require a definitive attribute map and
not just a subset. This will allow cache loader implementations to overwrite rather than merge, if that is
deemed more efficient. This will not break backward compatibility since performing a merge will not cause
any loss of data even though it is an unnecessary step.
put
in interface CacheLoader
put
in class AbstractDelegatingCacheLoader
name
- The fully qualified name of the nodeattributes
- A Map of attributes. Can be null
Exception
public void put(List<Modification> modifications) throws Exception
CacheLoader
put
in interface CacheLoader
put
in class AbstractDelegatingCacheLoader
modifications
- A ListException
public Object remove(Fqn fqn, Object key) throws Exception
CacheLoader
remove
in interface CacheLoader
remove
in class AbstractDelegatingCacheLoader
Exception
public void remove(Fqn fqn) throws Exception
CacheLoader
remove
in interface CacheLoader
remove
in class AbstractDelegatingCacheLoader
fqn
- the Fqn
of the node
Exception
public void removeData(Fqn fqn) throws Exception
CacheLoader
removeData
in interface CacheLoader
removeData
in class AbstractDelegatingCacheLoader
fqn
- the Fqn
of the node
Exception
public void prepare(Object tx, List<Modification> modifications, boolean one_phase) throws Exception
CacheLoader
tx
(tx is the key)
prepare
in interface CacheLoader
prepare
in class AbstractDelegatingCacheLoader
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
Exception
public void commit(Object tx) throws Exception
CacheLoader
tx
and commit that
transaction. Non-transactional CacheLoaders could simply write the data
that was previously saved transiently under the given tx
key, to (for example) a file system.
Note this only holds if the previous prepare() did not define one_phase=true
commit
in interface CacheLoader
commit
in class AbstractDelegatingCacheLoader
tx
- transaction to commit
Exception
public void rollback(Object tx)
CacheLoader
tx
and roll back that
transaction.
rollback
in interface CacheLoader
rollback
in class AbstractDelegatingCacheLoader
tx
- transaction to roll backpublic void storeEntireState(ObjectInputStream is) throws 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 AbstractDelegatingCacheLoader
is
- ObjectInputStream to read state
Exception
AbstractCacheLoader.storeEntireState(ObjectInputStream)
,
NodeData
public void storeState(Fqn subtree, ObjectInputStream is) throws 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 AbstractDelegatingCacheLoader
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
Exception
AbstractCacheLoader.storeState(Fqn,ObjectInputStream)
,
NodeData
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |