org.apache.jcs.auxiliary.remote.server.behavior
Interface IRemoteCacheServerAttributes

All Superinterfaces:

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

All Known Implementing Classes:

RemoteCacheServerAttributes

public interface IRemoteCacheServerAttributes
extends AuxiliaryCacheAttributes

This defeines the minimal behavior for the objects that are used to configure the remote cache server.

Field Summary

static int	CLUSTER A remote cache is either a local cache or a cluster cache
static int	LOCAL A remote cache is either a local cache or a cluster cache

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

POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE

Method Summary

boolean	getAllowClusterGet() Should we try to get remotely when the request does not come in from a cluster.
java.lang.String	getClusterServers() Gets the clusterServers attribute of the IRemoteCacheAttributes object.
java.lang.String	getConfigFileName() Gets the ConfigFileName attribute of the IRemoteCacheAttributes object.
boolean	getGetOnly() Gets the getOnly attribute of the IRemoteCacheAttributes object.
boolean	getLocalClusterConsistency() Should cluster updates be propogated to the locals.
java.lang.String	getRemoteHost() Gets the remoteHost attribute of the IRemoteCacheAttributes object.
int	getRemotePort() Gets the remotePort attribute of the IRemoteCacheAttributes object.
int	getRemoteType() Gets the remoteType attribute of the IRemoteCacheAttributes object.
java.lang.String	getRemoteTypeName() Gets the remoteTypeName attribute of the IRemoteCacheAttributes object.
boolean	getRemoveUponRemotePut() Gets the removeUponRemotePut attribute of the IRemoteCacheAttributes.
int	getServicePort() Gets the localPort attribute of the IRemoteCacheAttributes object.
void	setAllowClusterGet(boolean r) Should cluster updates be propogated to the locals.
void	setClusterServers(java.lang.String s) Sets the clusterServers attribute of the IRemoteCacheAttributes 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 IRemoteCacheAttributes object.
void	setLocalClusterConsistency(boolean r) Should cluster updates be propogated to the locals.
void	setRemoteHost(java.lang.String s) Sets the remoteHost attribute of the IRemoteCacheAttributes object.
void	setRemotePort(int p) Sets the remotePort attribute of the IRemoteCacheAttributes object.
void	setRemoteType(int p) Sets the remoteType attribute of the IRemoteCacheAttributes object.
void	setRemoteTypeName(java.lang.String s) Sets the remoteTypeName attribute of the IRemoteCacheAttributes object.
void	setRemoveUponRemotePut(boolean r) Sets the removeUponRemotePut attribute of the IRemoteCacheAttributes.
void	setServicePort(int p) Sets the localPort attribute of the IRemoteCacheAttributes object.

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

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

Field Detail

LOCAL

static final int LOCAL

A remote cache is either a local cache or a cluster cache

See Also:

Constant Field Values

CLUSTER

static final int CLUSTER

A remote cache is either a local cache or a cluster cache

See Also:

Constant Field Values

Method Detail

getRemoteTypeName

java.lang.String getRemoteTypeName()

Gets the remoteTypeName attribute of the IRemoteCacheAttributes object.

Returns:

The remoteTypeName value

setRemoteTypeName

void setRemoteTypeName(java.lang.String s)

Sets the remoteTypeName attribute of the IRemoteCacheAttributes object.

Parameters:

s - The new remoteTypeName value

getRemoteType

int getRemoteType()

Gets the remoteType attribute of the IRemoteCacheAttributes object.

Returns:

The remoteType value

setRemoteType

void setRemoteType(int p)

Sets the remoteType attribute of the IRemoteCacheAttributes object.

Parameters:

p - The new remoteType value

getRemoteHost

java.lang.String getRemoteHost()

Gets the remoteHost attribute of the IRemoteCacheAttributes object.

Returns:

The remoteHost value

setRemoteHost

void setRemoteHost(java.lang.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

getServicePort

int getServicePort()

Gets the localPort attribute of the IRemoteCacheAttributes object.

Returns:

The localPort value

setServicePort

void setServicePort(int p)

Sets the localPort attribute of the IRemoteCacheAttributes object.

Parameters:

p - The new localPort value

getClusterServers

java.lang.String getClusterServers()

Gets the clusterServers attribute of the IRemoteCacheAttributes object.

Returns:

The clusterServers value

setClusterServers

void setClusterServers(java.lang.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. A remote cache is either a local cache or a cluster cache

Returns:

The getOnly value

setGetOnly

void setGetOnly(boolean r)

Sets the getOnly attribute of the IRemoteCacheAttributes object.

Parameters:

r - The new getOnly value

getLocalClusterConsistency

boolean getLocalClusterConsistency()

Should cluster updates be propogated to the locals.

Returns:

The localClusterConsistency value

setLocalClusterConsistency

void setLocalClusterConsistency(boolean r)

Should cluster updates be propogated to the locals.

Parameters:

r - The new localClusterConsistency value

getAllowClusterGet

boolean getAllowClusterGet()

Should we try to get remotely when the request does not come in from a cluster. If local L1 asks remote server R1 for element A and R1 doesn't have it, should R1 look remotely? The difference is between a local and a remote update. The local update stays local. Normal updates, removes, etc, stay local when they come from a client. If this is set to true, then they can go remote.

Returns:

The localClusterConsistency value

setAllowClusterGet

void setAllowClusterGet(boolean r)

Should cluster updates be propogated to the locals.

Parameters:

r - The new localClusterConsistency value

getConfigFileName

java.lang.String getConfigFileName()

Gets the ConfigFileName attribute of the IRemoteCacheAttributes object.

Returns:

The clusterServers value

setConfigFileName

void setConfigFileName(java.lang.String s)

Sets the ConfigFileName attribute of the IRemoteCacheAttributes object.

Parameters:

s - The new clusterServers value