org.apache.jcs.auxiliary.remote.server

Class RemoteCacheServerAttributes

java.lang.Object

org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes

org.apache.jcs.auxiliary.remote.server.RemoteCacheServerAttributes

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, AuxiliaryCacheAttributes, IRemoteCacheServerAttributes

public class RemoteCacheServerAttributes
extends AbstractAuxiliaryCacheAttributes
implements IRemoteCacheServerAttributes

These attributes are used to configure the remote cache server.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MS Factory socket time out.

Fields inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes

cacheName, eventQueuePoolName, eventQueueType, name

Fields inherited from interface org.apache.jcs.auxiliary.remote.server.behavior.IRemoteCacheServerAttributes

CLUSTER, LOCAL

Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes

POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE

Constructor Summary

Constructors

Constructor and Description
RemoteCacheServerAttributes() Default constructor for the RemoteCacheAttributes object

Method Summary

Methods

Modifier and Type	Method and Description
AuxiliaryCacheAttributes	copy() clones
boolean	getAllowClusterGet() Should gets from non-cluster clients be allowed to get from other remote auxiliaries.
java.lang.String	getClusterServers() Gets the clusterServers attribute of the RemoteCacheAttributes object
java.lang.String	getConfigFileName() Gets the ConfigFileName attribute of the IRemoteCacheAttributes object
boolean	getGetOnly() Gets the getOnly attribute of the RemoteCacheAttributes object
boolean	getLocalClusterConsistency() Should cluster updates be propagated to the locals
long	getRegistryKeepAliveDelayMillis()
java.lang.String	getRemoteHost() Gets the remoteHost attribute of the RemoteCacheAttributes object
int	getRemotePort() Gets the remotePort attribute of the RemoteCacheAttributes object
java.lang.String	getRemoteServiceName() Gets the remoteServiceName attribute of the RemoteCacheAttributes object
int	getRemoteType() Gets the remoteType attribute of the RemoteCacheAttributes object
java.lang.String	getRemoteTypeName() Gets the remoteTypeName attribute of the RemoteCacheAttributes object
boolean	getRemoveUponRemotePut() Gets the removeUponRemotePut attribute of the RemoteCacheAttributes object
int	getRmiSocketFactoryTimeoutMillis()
int	getServicePort() Gets the localPort attribute of the RemoteCacheAttributes object
boolean	isAllowClusterGet() Should gets from non-cluster clients be allowed to get from other remote auxiliaries.
boolean	isLocalClusterConsistency() Should cluster updates be propagated to the locals
boolean	isStartRegistry() Should we start the registry
boolean	isUseRegistryKeepAlive() Should we try to keep the registry alive
void	setAllowClusterGet(boolean r) Should we try to get from other cluster servers if we don't find the items locally.
void	setClusterServers(java.lang.String s) Sets the clusterServers attribute of the RemoteCacheAttributes object
void	setConfigFileName(java.lang.String s) Sets the ConfigFileName attribute of the IRemoteCacheAttributes 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	setRegistryKeepAliveDelayMillis(long registryKeepAliveDelayMillis)
void	setRemoteHost(java.lang.String s) Sets the remoteHost attribute of the RemoteCacheAttributes object
void	setRemotePort(int p) Sets the remotePort attribute of the RemoteCacheAttributes object
void	setRemoteServiceName(java.lang.String s) Sets the remoteServiceName attribute of the RemoteCacheAttributes object
void	setRemoteType(int p) Sets the remoteType attribute of the RemoteCacheAttributes object
void	setRemoteTypeName(java.lang.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)
void	setServicePort(int p) Sets the localPort attribute of the RemoteCacheAttributes object
void	setStartRegistry(boolean startRegistry) Should we start the registry
void	setUseRegistryKeepAlive(boolean useRegistryKeepAlive) Should we try to keep the registry alive
java.lang.String	toString()

Methods inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes

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

Field Detail

DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MS

public static final int DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MS

Factory socket time out.

See Also:

Constant Field Values

Constructor Detail

RemoteCacheServerAttributes

public RemoteCacheServerAttributes()

Default constructor for the RemoteCacheAttributes object

Method Detail

getRemoteTypeName

public java.lang.String getRemoteTypeName()

Gets the remoteTypeName attribute of the RemoteCacheAttributes object

Specified by:

getRemoteTypeName in interface IRemoteCacheServerAttributes

Returns:

The remoteTypeName value

setRemoteTypeName

public void setRemoteTypeName(java.lang.String s)

Sets the remoteTypeName attribute of the RemoteCacheAttributes object

Specified by:

setRemoteTypeName in interface IRemoteCacheServerAttributes

Parameters:

s - The new remoteTypeName value

getRemoteType

public int getRemoteType()

Gets the remoteType attribute of the RemoteCacheAttributes object

Specified by:

getRemoteType in interface IRemoteCacheServerAttributes

Returns:

The remoteType value

setRemoteType

public void setRemoteType(int p)

Sets the remoteType attribute of the RemoteCacheAttributes object

Specified by:

setRemoteType in interface IRemoteCacheServerAttributes

Parameters:

p - The new remoteType value

copy

public AuxiliaryCacheAttributes copy()

clones

Specified by:

copy in interface AuxiliaryCacheAttributes

Returns:

AuxiliaryCacheAttributes clone

getRemoteServiceName

public java.lang.String getRemoteServiceName()

Gets the remoteServiceName attribute of the RemoteCacheAttributes object

Returns:

The remoteServiceName value

setRemoteServiceName

public void setRemoteServiceName(java.lang.String s)

Sets the remoteServiceName attribute of the RemoteCacheAttributes object

Parameters:

s - The new remoteServiceName value

getRemoteHost

public java.lang.String getRemoteHost()

Gets the remoteHost attribute of the RemoteCacheAttributes object

Specified by:

getRemoteHost in interface IRemoteCacheServerAttributes

Returns:

The remoteHost value

setRemoteHost

public void setRemoteHost(java.lang.String s)

Sets the remoteHost attribute of the RemoteCacheAttributes object

Specified by:

setRemoteHost in interface IRemoteCacheServerAttributes

Parameters:

s - The new remoteHost value

getRemotePort

public int getRemotePort()

Gets the remotePort attribute of the RemoteCacheAttributes object

Specified by:

getRemotePort in interface IRemoteCacheServerAttributes

Returns:

The remotePort value

setRemotePort

public void setRemotePort(int p)

Sets the remotePort attribute of the RemoteCacheAttributes object

Specified by:

setRemotePort in interface IRemoteCacheServerAttributes

Parameters:

p - The new remotePort value

getClusterServers

public java.lang.String getClusterServers()

Gets the clusterServers attribute of the RemoteCacheAttributes object

Specified by:

getClusterServers in interface IRemoteCacheServerAttributes

Returns:

The clusterServers value

setClusterServers

public void setClusterServers(java.lang.String s)

Sets the clusterServers attribute of the RemoteCacheAttributes object

Specified by:

setClusterServers in interface IRemoteCacheServerAttributes

Parameters:

s - The new clusterServers value

getServicePort

public int getServicePort()

Gets the localPort attribute of the RemoteCacheAttributes object

Specified by:

getServicePort in interface IRemoteCacheServerAttributes

Returns:

The localPort value

setServicePort

public void setServicePort(int p)

Sets the localPort attribute of the RemoteCacheAttributes object

Specified by:

setServicePort in interface IRemoteCacheServerAttributes

Parameters:

p - The new localPort value

getRemoveUponRemotePut

public boolean getRemoveUponRemotePut()

Gets the removeUponRemotePut attribute of the RemoteCacheAttributes object

Specified by:

getRemoveUponRemotePut in interface IRemoteCacheServerAttributes

Returns:

The removeUponRemotePut value

setRemoveUponRemotePut

public void setRemoveUponRemotePut(boolean r)

Sets the removeUponRemotePut attribute of the RemoteCacheAttributes object

Specified by:

setRemoveUponRemotePut in interface IRemoteCacheServerAttributes

Parameters:

r - The new removeUponRemotePut value

getGetOnly

public boolean getGetOnly()

Gets the getOnly attribute of the RemoteCacheAttributes object

Specified by:

getGetOnly in interface IRemoteCacheServerAttributes

Returns:

The getOnly value

setGetOnly

public void setGetOnly(boolean r)

Sets the getOnly attribute of the RemoteCacheAttributes object

Specified by:

setGetOnly in interface IRemoteCacheServerAttributes

Parameters:

r - The new getOnly value

getLocalClusterConsistency

public boolean getLocalClusterConsistency()

Should cluster updates be propagated to the locals

Specified by:

getLocalClusterConsistency in interface IRemoteCacheServerAttributes

Returns:

The localClusterConsistency value

isLocalClusterConsistency

public boolean isLocalClusterConsistency()

Should cluster updates be propagated to the locals

Returns:

The localClusterConsistency value

setLocalClusterConsistency

public void setLocalClusterConsistency(boolean r)

Should cluster updates be propagated to the locals

Specified by:

setLocalClusterConsistency in interface IRemoteCacheServerAttributes

Parameters:

r - The new localClusterConsistency value

getAllowClusterGet

public boolean getAllowClusterGet()

Should gets from non-cluster clients be allowed to get from other remote auxiliaries.

Specified by:

getAllowClusterGet in interface IRemoteCacheServerAttributes

Returns:

The localClusterConsistency value

isAllowClusterGet

public boolean isAllowClusterGet()

Should gets from non-cluster clients be allowed to get from other remote auxiliaries.

Returns:

The localClusterConsistency value

setAllowClusterGet

public void setAllowClusterGet(boolean r)

Should we try to get from other cluster servers if we don't find the items locally.

Specified by:

setAllowClusterGet in interface IRemoteCacheServerAttributes

Parameters:

r - The new localClusterConsistency value

getConfigFileName

public java.lang.String getConfigFileName()

Gets the ConfigFileName attribute of the IRemoteCacheAttributes object

Specified by:

getConfigFileName in interface IRemoteCacheServerAttributes

Returns:

The clusterServers value

setConfigFileName

public void setConfigFileName(java.lang.String s)

Sets the ConfigFileName attribute of the IRemoteCacheAttributes object

Specified by:

setConfigFileName in interface IRemoteCacheServerAttributes

Parameters:

s - The new clusterServers value

setRmiSocketFactoryTimeoutMillis

public void setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)

Specified by:

setRmiSocketFactoryTimeoutMillis in interface IRemoteCacheServerAttributes

Parameters:

rmiSocketFactoryTimeoutMillis - The rmiSocketFactoryTimeoutMillis to set.

getRmiSocketFactoryTimeoutMillis

public int getRmiSocketFactoryTimeoutMillis()

Specified by:

getRmiSocketFactoryTimeoutMillis in interface IRemoteCacheServerAttributes

Returns:

Returns the rmiSocketFactoryTimeoutMillis.

setUseRegistryKeepAlive

public void setUseRegistryKeepAlive(boolean useRegistryKeepAlive)

Should we try to keep the registry alive

Specified by:

setUseRegistryKeepAlive in interface IRemoteCacheServerAttributes

Parameters:

useRegistryKeepAlive - the useRegistryKeepAlive to set

setStartRegistry

public void setStartRegistry(boolean startRegistry)

Should we start the registry

Specified by:

setStartRegistry in interface IRemoteCacheServerAttributes

Parameters:

startRegistry - the startRegistry to set

isStartRegistry

public boolean isStartRegistry()

Should we start the registry

Specified by:

isStartRegistry in interface IRemoteCacheServerAttributes

Returns:

the startRegistry

isUseRegistryKeepAlive

public boolean isUseRegistryKeepAlive()

Should we try to keep the registry alive

Specified by:

isUseRegistryKeepAlive in interface IRemoteCacheServerAttributes

Returns:

the useRegistryKeepAlive

setRegistryKeepAliveDelayMillis

public void setRegistryKeepAliveDelayMillis(long registryKeepAliveDelayMillis)

Specified by:

setRegistryKeepAliveDelayMillis in interface IRemoteCacheServerAttributes

Parameters:

registryKeepAliveDelayMillis - the registryKeepAliveDelayMillis to set

getRegistryKeepAliveDelayMillis

public long getRegistryKeepAliveDelayMillis()

Specified by:

getRegistryKeepAliveDelayMillis in interface IRemoteCacheServerAttributes

Returns:

the registryKeepAliveDelayMillis

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String details