org.apache.jcs.auxiliary.remote.behavior
Interface ICommonRemoteCacheAttributes

All Superinterfaces:
AuxiliaryCacheAttributes, Cloneable, Serializable
All Known Subinterfaces:
IRemoteCacheAttributes, IRemoteCacheServerAttributes
All Known Implementing Classes:
CommonRemoteCacheAttributes, RemoteCacheAttributes, RemoteCacheServerAttributes, RemoteHttpCacheAttributes

public interface ICommonRemoteCacheAttributes
extends AuxiliaryCacheAttributes

This specifies what a remote cache configuration object should look like.


Field Summary
static int DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS
          The default timeout for the custom RMI socket factory
 
Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE
 
Method Summary
 String getClusterServers()
          Gets the clusterServers attribute of the IRemoteCacheAttributes object
 boolean getGetOnly()
          Gets the getOnly attribute of the IRemoteCacheAttributes object
 String getRemoteHost()
          Gets the remoteHost attribute of the IRemoteCacheAttributes object
 int getRemotePort()
          Gets the remotePort attribute of the IRemoteCacheAttributes object
 String getRemoteServiceName()
          Gets the remoteServiceName attribute of the IRemoteCacheAttributes object
 RemoteType getRemoteType()
          Gets the remoteType attribute of the IRemoteCacheAttributes object
 String getRemoteTypeName()
          Gets the remoteTypeName attribute of the IRemoteCacheAttributes object
 boolean getRemoveUponRemotePut()
          Gets the removeUponRemotePut attribute of the IRemoteCacheAttributes object
 int getRmiSocketFactoryTimeoutMillis()
          This sets a general timeout on the rmi socket factory.
 boolean isLocalClusterConsistency()
          Should cluster updates be propagated to the locals
 void setClusterServers(String s)
          Sets the clusterServers attribute of the IRemoteCacheAttributes object
 void setGetOnly(boolean r)
          Sets the getOnly attribute of the IRemoteCacheAttributes object
 void setLocalClusterConsistency(boolean r)
          Should cluster updates be propagated to the locals
 void setRemoteHost(String s)
          Sets the remoteHost attribute of the IRemoteCacheAttributes object
 void setRemotePort(int p)
          Sets the remotePort attribute of the IRemoteCacheAttributes object
 void setRemoteServiceName(String s)
          Sets the remoteServiceName attribute of the IRemoteCacheAttributes object
 void setRemoteType(RemoteType p)
          Sets the remoteType attribute of the IRemoteCacheAttributes object
 void setRemoteTypeName(String s)
          Sets the remoteTypeName attribute of the IRemoteCacheAttributes object
 void setRemoveUponRemotePut(boolean r)
          Sets the removeUponRemotePut attribute of the IRemoteCacheAttributes object
 void setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)
          This sets a general timeout on the RMI socket factory.
 
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
copy, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
 

Field Detail

DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS

static final int DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS
The default timeout for the custom RMI socket factory

See Also:
Constant Field Values
Method Detail

getRemoteTypeName

String getRemoteTypeName()
Gets the remoteTypeName attribute of the IRemoteCacheAttributes object

Returns:
The remoteTypeName value

setRemoteTypeName

void setRemoteTypeName(String s)
Sets the remoteTypeName attribute of the IRemoteCacheAttributes object

Parameters:
s - The new remoteTypeName value

getRemoteType

RemoteType getRemoteType()
Gets the remoteType attribute of the IRemoteCacheAttributes object

Returns:
The remoteType value

setRemoteType

void setRemoteType(RemoteType p)
Sets the remoteType attribute of the IRemoteCacheAttributes object

Parameters:
p - The new remoteType value

getRemoteServiceName

String getRemoteServiceName()
Gets the remoteServiceName attribute of the IRemoteCacheAttributes object

Returns:
The remoteServiceName value

setRemoteServiceName

void setRemoteServiceName(String s)
Sets the remoteServiceName attribute of the IRemoteCacheAttributes object

Parameters:
s - The new remoteServiceName value

getRemoteHost

String getRemoteHost()
Gets the remoteHost attribute of the IRemoteCacheAttributes object

Returns:
The remoteHost value

setRemoteHost

void setRemoteHost(String s)
Sets the remoteHost attribute of the IRemoteCacheAttributes object

Parameters:
s - The new remoteHost value

getRemotePort

int getRemotePort()
Gets the remotePort attribute of the IRemoteCacheAttributes object

Returns:
The remotePort value

setRemotePort

void setRemotePort(int p)
Sets the remotePort attribute of the IRemoteCacheAttributes object

Parameters:
p - The new remotePort value

getClusterServers

String getClusterServers()
Gets the clusterServers attribute of the IRemoteCacheAttributes object

Returns:
The clusterServers value

setClusterServers

void setClusterServers(String s)
Sets the clusterServers attribute of the IRemoteCacheAttributes object

Parameters:
s - The new clusterServers value

getRemoveUponRemotePut

boolean getRemoveUponRemotePut()
Gets the removeUponRemotePut attribute of the IRemoteCacheAttributes object

Returns:
The removeUponRemotePut value

setRemoveUponRemotePut

void setRemoveUponRemotePut(boolean r)
Sets the removeUponRemotePut attribute of the IRemoteCacheAttributes object

Parameters:
r - The new removeUponRemotePut value

getGetOnly

boolean getGetOnly()
Gets the getOnly attribute of the IRemoteCacheAttributes object

Returns:
The getOnly value

setGetOnly

void setGetOnly(boolean r)
Sets the getOnly attribute of the IRemoteCacheAttributes object

Parameters:
r - The new getOnly value

isLocalClusterConsistency

boolean isLocalClusterConsistency()
Should cluster updates be propagated to the locals

Returns:
The localClusterConsistency value

setLocalClusterConsistency

void setLocalClusterConsistency(boolean r)
Should cluster updates be propagated to the locals

Parameters:
r - The new localClusterConsistency value

getRmiSocketFactoryTimeoutMillis

int getRmiSocketFactoryTimeoutMillis()
This sets a general timeout on the rmi socket factory. By default the socket factory will block forever.

We have a default setting. The default rmi behavior should never be used.

Returns:
int milliseconds

setRmiSocketFactoryTimeoutMillis

void setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)
This sets a general timeout on the RMI socket factory. By default the socket factory will block forever.

Parameters:
rmiSocketFactoryTimeoutMillis -


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.