Package org.apache.commons.jcs3.auxiliary.remote

Class CommonRemoteCacheAttributes

java.lang.Object

org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes

org.apache.commons.jcs3.auxiliary.remote.CommonRemoteCacheAttributes

All Implemented Interfaces:

Serializable, Cloneable, AuxiliaryCacheAttributes, ICommonRemoteCacheAttributes

Direct Known Subclasses:

RemoteCacheAttributes, RemoteCacheServerAttributes

public class CommonRemoteCacheAttributes
extends AbstractAuxiliaryCacheAttributes
implements ICommonRemoteCacheAttributes

Attributes common to remote cache client and server.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.ICommonRemoteCacheAttributes

DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor	Description
CommonRemoteCacheAttributes()	Default constructor for the RemoteCacheAttributes object

Method Summary

Modifier and Type	Method	Description
String	getClusterServers()	Gets the clusterServers attribute of the RemoteCacheAttributes object.
boolean	getGetOnly()	Gets the getOnly attribute of the RemoteCacheAttributes object.
RemoteLocation	getRemoteLocation()	Gets the location attribute of the RemoteCacheAttributes object.
String	getRemoteServiceName()	Gets the remoteServiceName attribute of the RemoteCacheAttributes object.
RemoteType	getRemoteType()	Gets the remoteType attribute of the RemoteCacheAttributes object.
String	getRemoteTypeName()	Gets the remoteTypeName attribute of the RemoteCacheAttributes object.
boolean	getRemoveUponRemotePut()	Gets the removeUponRemotePut attribute of the RemoteCacheAttributes 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 RemoteCacheAttributes object.
void	setGetOnly(boolean r)	Sets the getOnly attribute of the RemoteCacheAttributes object
void	setLocalClusterConsistency(boolean r)	Should cluster updates be propagated to the locals.
void	setRemoteLocation(String host, int port)	Sets the location attribute of the RemoteCacheAttributes object.
void	setRemoteLocation(RemoteLocation location)	Sets the location attribute of the RemoteCacheAttributes object.
void	setRemoteServiceName(String s)	Sets the remoteServiceName attribute of the RemoteCacheAttributes object.
void	setRemoteType(RemoteType p)	Sets the remoteType attribute of the RemoteCacheAttributes object.
void	setRemoteTypeName(String s)	Sets the remoteTypeName attribute of the RemoteCacheAttributes object.
void	setRemoveUponRemotePut(boolean r)	Sets the removeUponRemotePut attribute of the RemoteCacheAttributes object.
void	setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)	This sets a general timeout on the RMI socket factory.
String	toString()

Methods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes

clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributes

clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName

Constructor Details

CommonRemoteCacheAttributes

public CommonRemoteCacheAttributes()

Default constructor for the RemoteCacheAttributes object

Method Details

getRemoteTypeName

public String getRemoteTypeName()

Gets the remoteTypeName attribute of the RemoteCacheAttributes object.

Specified by:

getRemoteTypeName in interface ICommonRemoteCacheAttributes

Returns:

The remoteTypeName value

setRemoteTypeName

public void setRemoteTypeName(String s)

Sets the remoteTypeName attribute of the RemoteCacheAttributes object.

Specified by:

setRemoteTypeName in interface ICommonRemoteCacheAttributes

Parameters:

s - The new remoteTypeName value

getRemoteType

public RemoteType getRemoteType()

Gets the remoteType attribute of the RemoteCacheAttributes object.

Specified by:

getRemoteType in interface ICommonRemoteCacheAttributes

Returns:

The remoteType value

setRemoteType

public void setRemoteType(RemoteType p)

Sets the remoteType attribute of the RemoteCacheAttributes object.

Specified by:

setRemoteType in interface ICommonRemoteCacheAttributes

Parameters:

p - The new remoteType value

getRemoteServiceName

public String getRemoteServiceName()

Gets the remoteServiceName attribute of the RemoteCacheAttributes object.

Specified by:

getRemoteServiceName in interface ICommonRemoteCacheAttributes

Returns:

The remoteServiceName value

setRemoteServiceName

public void setRemoteServiceName(String s)

Sets the remoteServiceName attribute of the RemoteCacheAttributes object.

Specified by:

setRemoteServiceName in interface ICommonRemoteCacheAttributes

Parameters:

s - The new remoteServiceName value

setRemoteLocation

public void setRemoteLocation(RemoteLocation location)

Sets the location attribute of the RemoteCacheAttributes object.

Specified by:

setRemoteLocation in interface ICommonRemoteCacheAttributes

Parameters:

location - The new location value

setRemoteLocation

public void setRemoteLocation(String host,
 int port)

Sets the location attribute of the RemoteCacheAttributes object.

Specified by:

setRemoteLocation in interface ICommonRemoteCacheAttributes

Parameters:

host - The new remoteHost value

port - The new remotePort value

getRemoteLocation

public RemoteLocation getRemoteLocation()

Gets the location attribute of the RemoteCacheAttributes object.

Specified by:

getRemoteLocation in interface ICommonRemoteCacheAttributes

Returns:

The remote location value

getClusterServers

public String getClusterServers()

Gets the clusterServers attribute of the RemoteCacheAttributes object.

Specified by:

getClusterServers in interface ICommonRemoteCacheAttributes

Returns:

The clusterServers value

setClusterServers

public void setClusterServers(String s)

Sets the clusterServers attribute of the RemoteCacheAttributes object.

Specified by:

setClusterServers in interface ICommonRemoteCacheAttributes

Parameters:

s - The new clusterServers value

getRemoveUponRemotePut

public boolean getRemoveUponRemotePut()

Gets the removeUponRemotePut attribute of the RemoteCacheAttributes object.

Specified by:

getRemoveUponRemotePut in interface ICommonRemoteCacheAttributes

Returns:

The removeUponRemotePut value

setRemoveUponRemotePut

public void setRemoveUponRemotePut(boolean r)

Sets the removeUponRemotePut attribute of the RemoteCacheAttributes object.

Specified by:

setRemoveUponRemotePut in interface ICommonRemoteCacheAttributes

Parameters:

r - The new removeUponRemotePut value

getGetOnly

public boolean getGetOnly()

Gets the getOnly attribute of the RemoteCacheAttributes object.

Specified by:

getGetOnly in interface ICommonRemoteCacheAttributes

Returns:

The getOnly value

setGetOnly

public void setGetOnly(boolean r)

Sets the getOnly attribute of the RemoteCacheAttributes object

Specified by:

setGetOnly in interface ICommonRemoteCacheAttributes

Parameters:

r - The new getOnly value

isLocalClusterConsistency

public boolean isLocalClusterConsistency()

Should cluster updates be propagated to the locals.

Specified by:

isLocalClusterConsistency in interface ICommonRemoteCacheAttributes

Returns:

The localClusterConsistency value

setLocalClusterConsistency

public void setLocalClusterConsistency(boolean r)

Should cluster updates be propagated to the locals.

Specified by:

setLocalClusterConsistency in interface ICommonRemoteCacheAttributes

Parameters:

r - The new localClusterConsistency value

setRmiSocketFactoryTimeoutMillis

public void setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)

Description copied from interface: ICommonRemoteCacheAttributes

This sets a general timeout on the RMI socket factory. By default the socket factory will block forever.

Specified by:

setRmiSocketFactoryTimeoutMillis in interface ICommonRemoteCacheAttributes

Parameters:

rmiSocketFactoryTimeoutMillis - The rmiSocketFactoryTimeoutMillis to set.

getRmiSocketFactoryTimeoutMillis

public int getRmiSocketFactoryTimeoutMillis()

Description copied from interface: ICommonRemoteCacheAttributes

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.

Specified by:

getRmiSocketFactoryTimeoutMillis in interface ICommonRemoteCacheAttributes

Returns:

Returns the rmiSocketFactoryTimeoutMillis.

toString

public String toString()

Overrides:

toString in class Object

Returns:

String, all the important values that can be configured