Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.cache.loader
Class TcpDelegatingCacheLoader

java.lang.Object
  extended by org.jboss.cache.loader.AbstractCacheLoader
      extended by org.jboss.cache.loader.TcpDelegatingCacheLoader
All Implemented Interfaces:
Lifecycle, CacheLoader
public class TcpDelegatingCacheLoader
extends AbstractCacheLoader

DelegatingCacheLoader implementation which delegates to a remote (not in the same VM) CacheImpl using TCP/IP for communication. Example configuration for connecting to a TcpCacheServer running at myHost:12345:

 org.jboss.cache.loader.TcpDelegatingCacheLoader
 
 host=localhost
 port=2099

Version:
$Id: TcpDelegatingCacheLoader.java 7465 2009-01-14 15:05:13Z manik.surtani@jboss.com $
Author:
Bela Ban

Field Summary
 
Fields inherited from class org.jboss.cache.loader.AbstractCacheLoader
buddyFqnTransformer, cache, regionManager, transactions
 
Constructor Summary
TcpDelegatingCacheLoader()
           
 
Method Summary
protected  boolean _exists(Fqn name)
           
protected  java.util.Map<java.lang.Object,java.lang.Object> _get(Fqn name)
           
protected  java.util.Set<?> _getChildrenNames(Fqn fqn)
           
protected  void _put(Fqn name, java.util.Map<java.lang.Object,java.lang.Object> attributes)
           
protected  java.lang.Object _put(Fqn name, java.lang.Object key, java.lang.Object value)
           
protected  void _put(java.util.List<Modification> modifications)
           
protected  void _remove(Fqn fqn)
           
protected  java.lang.Object _remove(Fqn fqn, java.lang.Object key)
           
protected  void _removeData(Fqn fqn)
           
 boolean exists(Fqn name)
          Returns true if the CacheLoader has a node with a Fqn.
 java.util.Map<java.lang.Object,java.lang.Object> get(Fqn name)
          Returns all keys and values from the persistent store, given a Fqn
 CacheLoaderConfig.IndividualCacheLoaderConfig getConfig()
          Gets the configuration.
 java.util.Set<?> getChildrenNames(Fqn fqn)
          Returns a set of children node names.
protected  java.lang.Object invokeWithRetries(java.lang.reflect.Method m, java.lang.Object... params)
          Invokes the specified Method with the specified parameters, catching SocketExceptions and attempting to reconnect to the TcpCacheServer if necessary.
 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 put(Fqn name, java.util.Map<java.lang.Object,java.lang.Object> 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.
 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)
          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.
 java.lang.Object remove(Fqn fqn, java.lang.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 setConfig(CacheLoaderConfig.IndividualCacheLoaderConfig base)
          Allows configuration via XML config file.
 void start()
           
 void stop()
           
 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
commit, create, destroy, doMarshall, doUnmarshall, getMarshaller, getNodeDataList, loadStateHelper, move, prepare, put, regionAwareMarshall, regionAwareUnmarshall, rollback, setCache, setRegionManager, storeStateHelper
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TcpDelegatingCacheLoader

public TcpDelegatingCacheLoader()
Method Detail

setConfig

public void setConfig(CacheLoaderConfig.IndividualCacheLoaderConfig base)
Allows configuration via XML config file.

Parameters:
base - May be an instance of the CacheLoaderConfig.IndividualCacheLoaderConfig base class, in which case the cache loader should use the PluggableConfigurationComponent.getProperties() method to find configuration information. Alternatively, may be a type-specific subclass of CacheLoaderConfig.IndividualCacheLoaderConfig, if there is one.

getConfig

public CacheLoaderConfig.IndividualCacheLoaderConfig getConfig()
Description copied from interface: CacheLoader
Gets the configuration.

Returns:
the configuration, represented by a CacheLoaderConfig.IndividualCacheLoaderConfig object.

invokeWithRetries

protected java.lang.Object invokeWithRetries(java.lang.reflect.Method m,
                                             java.lang.Object... params)
Invokes the specified Method with the specified parameters, catching SocketExceptions and attempting to reconnect to the TcpCacheServer if necessary.

Parameters:
m - method to invoke
params - parameters
Returns:
method return value

getChildrenNames

public java.util.Set<?> getChildrenNames(Fqn fqn)
                                  throws java.lang.Exception
Description copied from interface: CacheLoader
Returns a set of children node names. All names are relative to this parent 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().

Parameters:
fqn - The Fqn of the parent
Returns:
Set a set of children. Returns null if no children nodes are present, or the parent is not present
Throws:
java.lang.Exception

get

public java.util.Map<java.lang.Object,java.lang.Object> get(Fqn name)
                                                     throws java.lang.Exception
Description copied from interface: CacheLoader
Returns all keys and values from the persistent store, given a Fqn

Parameters:
name - the Fqn to search for.
Returns:
Map keys and values for the given node. Returns null if the node is not found. If the node is found but has no attributes, this method returns an empty Map.
Throws:
java.lang.Exception

exists

public boolean exists(Fqn name)
               throws java.lang.Exception
Description copied from interface: CacheLoader
Returns true if the CacheLoader has a node with a Fqn.

Returns:
true if node exists, false otherwise
Throws:
java.lang.Exception

put

public java.lang.Object put(Fqn name,
                            java.lang.Object key,
                            java.lang.Object value)
                     throws java.lang.Exception
Description copied from interface: CacheLoader
Puts a key and value into the attribute map of a given node. If the node does not exist, all parent nodes from the root down are created automatically. Returns the old value.

Throws:
java.lang.Exception

put

public void put(Fqn name,
                java.util.Map<java.lang.Object,java.lang.Object> attributes)
         throws java.lang.Exception
Description copied from interface: CacheLoader
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. This is the same behavior as Map.putAll(java.util.Map). 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.

Parameters:
name - The fully qualified name of the node
attributes - A Map of attributes. Can be null
Throws:
java.lang.Exception

put

public void put(java.util.List<Modification> modifications)
         throws java.lang.Exception
Description copied from interface: CacheLoader
Applies all modifications to the backend store. Changes may be applied in a single operation.

Specified by:
put in interface CacheLoader
Overrides:
put in class AbstractCacheLoader
Parameters:
modifications - A List of modifications
Throws:
java.lang.Exception

remove

public java.lang.Object remove(Fqn fqn,
                               java.lang.Object key)
                        throws java.lang.Exception
Description copied from interface: CacheLoader
Removes the given key and value from the attributes of the given node. Does nothing if the node doesn't exist Returns the removed value.

Throws:
java.lang.Exception

remove

public void remove(Fqn fqn)
            throws java.lang.Exception
Description copied from interface: CacheLoader
Removes the given node and all its subnodes, does nothing if the node does not exist.

Parameters:
fqn - the Fqn of the node
Throws:
java.lang.Exception

removeData

public void removeData(Fqn fqn)
                throws java.lang.Exception
Description copied from interface: CacheLoader
Removes all attributes from a given node, but doesn't delete the node itself or any subnodes.

Parameters:
fqn - the Fqn of the node
Throws:
java.lang.Exception

_getChildrenNames

protected java.util.Set<?> _getChildrenNames(Fqn fqn)
                                      throws java.lang.Exception
Throws:
java.lang.Exception

_get

protected java.util.Map<java.lang.Object,java.lang.Object> _get(Fqn name)
                                                         throws java.lang.Exception
Throws:
java.lang.Exception

_exists

protected boolean _exists(Fqn name)
                   throws java.lang.Exception
Throws:
java.lang.Exception

_put

protected java.lang.Object _put(Fqn name,
                                java.lang.Object key,
                                java.lang.Object value)
                         throws java.lang.Exception
Throws:
java.lang.Exception

_put

protected void _put(Fqn name,
                    java.util.Map<java.lang.Object,java.lang.Object> attributes)
             throws java.lang.Exception
Throws:
java.lang.Exception

_put

protected void _put(java.util.List<Modification> modifications)
             throws java.lang.Exception
Throws:
java.lang.Exception

_remove

protected java.lang.Object _remove(Fqn fqn,
                                   java.lang.Object key)
                            throws java.lang.Exception
Throws:
java.lang.Exception

_remove

protected void _remove(Fqn fqn)
                throws java.lang.Exception
Throws:
java.lang.Exception

_removeData

protected void _removeData(Fqn fqn)
                    throws java.lang.Exception
Throws:
java.lang.Exception

start

public void start()
           throws java.io.IOException
Specified by:
start in interface Lifecycle
Overrides:
start in class AbstractCacheLoader
Throws:
java.io.IOException

stop

public void stop()
Specified by:
stop in interface Lifecycle
Overrides:
stop in class AbstractCacheLoader

loadEntireState

public void loadEntireState(java.io.ObjectOutputStream os)
                     throws java.lang.Exception
Description copied from interface: CacheLoader
Fetches the entire state for this cache from secondary storage (disk, database) and writes it to a provided ObjectOutputStream. State written to the provided ObjectOutputStream parameter is used for initialization of a new CacheImpl instance. When the state gets transferred to the new cache instance its cacheloader calls 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.

Specified by:
loadEntireState in interface CacheLoader
Overrides:
loadEntireState in class AbstractCacheLoader
Parameters:
os - ObjectOutputStream to write state
Throws:
java.lang.Exception
See Also:
AbstractCacheLoader.loadEntireState(ObjectOutputStream), NodeData

loadState

public void loadState(Fqn subtree,
                      java.io.ObjectOutputStream os)
               throws java.lang.Exception
Description copied from interface: CacheLoader
Fetches a portion of the state for this cache from secondary storage (disk, database) and writes it to a provided ObjectOutputStream. State written to the provided ObjectOutputStream parameter is used for activation of a portion of a new CacheImpl instance. When the state gets transferred to the new cache instance its cacheloader calls 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.

Specified by:
loadState in interface CacheLoader
Overrides:
loadState in class AbstractCacheLoader
Parameters:
subtree - Fqn naming the root (i.e. highest level parent) node of the subtree for which state is requested.
os - ObjectOutputStream to write state
Throws:
java.lang.Exception
See Also:
AbstractCacheLoader.loadState(Fqn,ObjectOutputStream), Region.activate(), NodeData

storeEntireState

public void storeEntireState(java.io.ObjectInputStream is)
                      throws java.lang.Exception
Description copied from interface: CacheLoader
Stores the entire state for this cache by reading it from a provided ObjectInputStream. The state was provided to this cache by calling 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.

Specified by:
storeEntireState in interface CacheLoader
Overrides:
storeEntireState in class AbstractCacheLoader
Parameters:
is - ObjectInputStream to read state
Throws:
java.lang.Exception
See Also:
AbstractCacheLoader.storeEntireState(ObjectInputStream), NodeData

storeState

public void storeState(Fqn subtree,
                       java.io.ObjectInputStream is)
                throws java.lang.Exception
Description copied from interface: CacheLoader
Stores the given portion of the cache tree's state in secondary storage. Overwrite whatever is currently in secondary storage. If the transferred state has Fqns equal to or children of parameter 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.

Specified by:
storeState in interface CacheLoader
Overrides:
storeState in class AbstractCacheLoader
Parameters:
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
Throws:
java.lang.Exception
See Also:
AbstractCacheLoader.storeState(Fqn,ObjectInputStream), NodeData
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2009 JBoss, a division of Red Hat. All Rights Reserved.