org.jboss.cache.loader
Class RpcDelegatingCacheLoader

java.lang.Object
  org.jboss.cache.loader.DelegatingCacheLoader
      org.jboss.cache.loader.RpcDelegatingCacheLoader

All Implemented Interfaces:

CacheLoader, org.jboss.system.Service

public class RpcDelegatingCacheLoader
extends DelegatingCacheLoader

DelegatingCacheLoader implementation which delegates to a remote (not in the same VM) TreeCache using JGroups' RPC mechanism. The remote TreeCache delegated to is this cacheloader's cache's coordinator. This CacheLoader uses an optional configuration property, timeout, which specifies the timeout in milliseconds for each RPC call. If timeout is not specified, it defaults to 5000.

Version:

$Id: RpcDelegatingCacheLoader.java,v 1.7 2006/05/16 22:42:28 gzamarreno Exp $

Author:

Daniel Gredler

Field Summary

static java.lang.reflect.Method	METHOD_EXISTS
static java.lang.reflect.Method	METHOD_GET_CHILDREN_NAMES
static java.lang.reflect.Method	METHOD_GET_STATE
static java.lang.reflect.Method	METHOD_GET_WITH_1_PARAM
static java.lang.reflect.Method	METHOD_GET_WITH_2_PARAMS
static java.lang.reflect.Method	METHOD_PUT_WITH_2_PARAMS
static java.lang.reflect.Method	METHOD_PUT_WITH_3_PARAMS
static java.lang.reflect.Method	METHOD_REMOVE_DATA
static java.lang.reflect.Method	METHOD_REMOVE_WITH_1_PARAM
static java.lang.reflect.Method	METHOD_REMOVE_WITH_2_PARAMS
static java.lang.reflect.Method	METHOD_SET_STATE

Fields inherited from class org.jboss.cache.loader.DelegatingCacheLoader

delegateExists, delegateGet, delegateGetChildrenNames, delegateGetKey, delegateLoadEntireState, delegatePut, delegatePutKeyVal, delegateRemove, delegateRemoveData, delegateRemoveKey, delegateStoreEntireState, putList

Constructor Summary

RpcDelegatingCacheLoader()
Default constructor.

RpcDelegatingCacheLoader(TreeCache cache, int timeout)
Allows programmatic configuration.

Method Summary

protected boolean	delegateExists(Fqn name)
protected java.util.Map	delegateGet(Fqn name)
protected java.util.Set	delegateGetChildrenNames(Fqn name)
byte[]	delegateLoadEntireState()
protected void	delegatePut(Fqn name, java.util.Map attributes)
protected java.lang.Object	delegatePut(Fqn name, java.lang.Object key, java.lang.Object value)
protected void	delegatePut(java.util.List modifications)
protected void	delegateRemove(Fqn name)
protected java.lang.Object	delegateRemove(Fqn name, java.lang.Object key)
protected void	delegateRemoveData(Fqn name)
void	delegateStoreEntireState(byte[] state)
void	setCache(TreeCache cache) Allows configuration via XML config file.
void	setConfig(java.util.Properties props) Allows configuration via XML config file.

Methods inherited from class org.jboss.cache.loader.DelegatingCacheLoader

commit, create, destroy, exists, get, getChildrenNames, loadEntireState, prepare, put, put, put, put, remove, remove, removeData, rollback, start, stop, storeEntireState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METHOD_GET_STATE

public static final java.lang.reflect.Method METHOD_GET_STATE

METHOD_SET_STATE

public static final java.lang.reflect.Method METHOD_SET_STATE

METHOD_GET_CHILDREN_NAMES

public static final java.lang.reflect.Method METHOD_GET_CHILDREN_NAMES

METHOD_GET_WITH_2_PARAMS

public static final java.lang.reflect.Method METHOD_GET_WITH_2_PARAMS

METHOD_GET_WITH_1_PARAM

public static final java.lang.reflect.Method METHOD_GET_WITH_1_PARAM

METHOD_EXISTS

public static final java.lang.reflect.Method METHOD_EXISTS

METHOD_PUT_WITH_3_PARAMS

public static final java.lang.reflect.Method METHOD_PUT_WITH_3_PARAMS

METHOD_PUT_WITH_2_PARAMS

public static final java.lang.reflect.Method METHOD_PUT_WITH_2_PARAMS

METHOD_REMOVE_WITH_2_PARAMS

public static final java.lang.reflect.Method METHOD_REMOVE_WITH_2_PARAMS

METHOD_REMOVE_WITH_1_PARAM

public static final java.lang.reflect.Method METHOD_REMOVE_WITH_1_PARAM

METHOD_REMOVE_DATA

public static final java.lang.reflect.Method METHOD_REMOVE_DATA

Constructor Detail

RpcDelegatingCacheLoader

public RpcDelegatingCacheLoader()

Default constructor.

RpcDelegatingCacheLoader

public RpcDelegatingCacheLoader(TreeCache cache,
                                int timeout)

Allows programmatic configuration.

Parameters:

timeout - The timeout in milliseconds for each RPC call.

Method Detail

setConfig

public void setConfig(java.util.Properties props)

Allows configuration via XML config file.

Specified by:

setConfig in interface CacheLoader

Specified by:

setConfig in class DelegatingCacheLoader

Parameters:

props - a collection of configuration properties

See Also:

DelegatingCacheLoader.setConfig(java.util.Properties)

setCache

public void setCache(TreeCache cache)

Allows configuration via XML config file.

Specified by:

setCache in interface CacheLoader

Specified by:

setCache in class DelegatingCacheLoader

Parameters:

cache - The cache on which this loader works

See Also:

DelegatingCacheLoader.setCache(org.jboss.cache.TreeCache)

delegateGetChildrenNames

protected java.util.Set delegateGetChildrenNames(Fqn name)
                                          throws java.lang.Exception

Specified by:

delegateGetChildrenNames in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateGetChildrenNames(org.jboss.cache.Fqn)

delegateGet

protected java.util.Map delegateGet(Fqn name)
                             throws java.lang.Exception

Specified by:

delegateGet in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateGet(org.jboss.cache.Fqn)

delegateExists

protected boolean delegateExists(Fqn name)
                          throws java.lang.Exception

Specified by:

delegateExists in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateExists(org.jboss.cache.Fqn)

delegatePut

protected java.lang.Object delegatePut(Fqn name,
                                       java.lang.Object key,
                                       java.lang.Object value)
                                throws java.lang.Exception

Specified by:

delegatePut in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegatePut(org.jboss.cache.Fqn, java.lang.Object, java.lang.Object)

delegatePut

protected void delegatePut(Fqn name,
                           java.util.Map attributes)
                    throws java.lang.Exception

Specified by:

delegatePut in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegatePut(org.jboss.cache.Fqn, java.util.Map)

delegatePut

protected void delegatePut(java.util.List modifications)
                    throws java.lang.Exception

Specified by:

delegatePut in class DelegatingCacheLoader

Throws:

java.lang.Exception

delegateRemove

protected java.lang.Object delegateRemove(Fqn name,
                                          java.lang.Object key)
                                   throws java.lang.Exception

Specified by:

delegateRemove in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateRemove(org.jboss.cache.Fqn, java.lang.Object)

delegateRemove

protected void delegateRemove(Fqn name)
                       throws java.lang.Exception

Specified by:

delegateRemove in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateRemove(org.jboss.cache.Fqn)

delegateRemoveData

protected void delegateRemoveData(Fqn name)
                           throws java.lang.Exception

Specified by:

delegateRemoveData in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateRemoveData(org.jboss.cache.Fqn)

delegateLoadEntireState

public byte[] delegateLoadEntireState()
                               throws java.lang.Exception

Specified by:

delegateLoadEntireState in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateLoadEntireState()

delegateStoreEntireState

public void delegateStoreEntireState(byte[] state)
                              throws java.lang.Exception

Specified by:

delegateStoreEntireState in class DelegatingCacheLoader

Throws:

java.lang.Exception

See Also:

DelegatingCacheLoader.delegateStoreEntireState(byte[])