org.apache.jcs.auxiliary.lateral.behavior
Interface ILateralCacheAttributes

All Superinterfaces:
AuxiliaryCacheAttributes, Cloneable, Serializable
All Known Subinterfaces:
ITCPLateralCacheAttributes
All Known Implementing Classes:
LateralCacheAttributes, TCPLateralCacheAttributes

public interface ILateralCacheAttributes
extends Serializable, AuxiliaryCacheAttributes

This interface defines configuration options common to lateral cache plugins.

TODO it needs to be trimmed down. The old version had features for every lateral. Now, the individual laterals have their own specific attributes interfaces.


Field Summary
static int DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
          The number of elements the zombie queue will hold.
static int HTTP
          HTTP type
static int TCP
          TCP type
static int UDP
          UDP type
static int XMLRPC
          XMLRPC type
 
Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE
 
Method Summary
 int getHttpListenerPort()
          Gets the httpListenerPort attribute of the ILateralCacheAttributes object
 String getHttpServer()
          Gets the httpServer attribute of the ILateralCacheAttributes object
 String getHttpServers()
          Gets the httpSrvers attribute of the LateralCacheAttributes object
 boolean getPutOnlyMode()
           
 int getTransmissionType()
          Gets the transmissionType attribute of the ILateralCacheAttributes object
 String getTransmissionTypeName()
          Gets the transmissionTypeName attribute of the ILateralCacheAttributes object
 String getUdpMulticastAddr()
          Gets the udpMulticastAddr attribute of the ILateralCacheAttributes object
 int getUdpMulticastPort()
          Gets the udpMulticastPort attribute of the ILateralCacheAttributes object
 int getZombieQueueMaxSize()
          The number of elements the zombie queue will hold.
 boolean isReceive()
          Should a listener be created.
 void setHttpListenerPort(int val)
          Sets the httpListenerPort attribute of the ILateralCacheAttributes object
 void setHttpServer(String val)
          Sets the httpServer attribute of the ILateralCacheAttributes object
 void setHttpServers(String val)
          Sets the httpServers attribute of the LateralCacheAttributes object
 void setPutOnlyMode(boolean val)
          Sets the putOnlyMode attribute of the ILateralCacheAttributes.
 void setReceive(boolean receive)
           
 void setTransmissionType(int val)
          Sets the transmissionType attribute of the ILateralCacheAttributes object
 void setTransmissionTypeName(String val)
          Sets the transmissionTypeName attribute of the ILateralCacheAttributes object
 void setUdpMulticastAddr(String val)
          Sets the udpMulticastAddr attribute of the ILateralCacheAttributes object
 void setUdpMulticastPort(int val)
          Sets the udpMulticastPort attribute of the ILateralCacheAttributes object
 void setZombieQueueMaxSize(int zombieQueueMaxSize)
          The number of elements the zombie queue will hold.
 
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
copy, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
 

Field Detail

HTTP

static final int HTTP
HTTP type

See Also:
Constant Field Values

UDP

static final int UDP
UDP type

See Also:
Constant Field Values

TCP

static final int TCP
TCP type

See Also:
Constant Field Values

XMLRPC

static final int XMLRPC
XMLRPC type

See Also:
Constant Field Values

DEFAULT_ZOMBIE_QUEUE_MAX_SIZE

static final int DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
The number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.

See Also:
Constant Field Values
Method Detail

setHttpServer

void setHttpServer(String val)
Sets the httpServer attribute of the ILateralCacheAttributes object

Parameters:
val - The new httpServer value

getHttpServer

String getHttpServer()
Gets the httpServer attribute of the ILateralCacheAttributes object

Returns:
The httpServer value

setHttpListenerPort

void setHttpListenerPort(int val)
Sets the httpListenerPort attribute of the ILateralCacheAttributes object

Parameters:
val - The new tcpListenerPort value

getHttpListenerPort

int getHttpListenerPort()
Gets the httpListenerPort attribute of the ILateralCacheAttributes object

Returns:
The httpListenerPort value

setHttpServers

void setHttpServers(String val)
Sets the httpServers attribute of the LateralCacheAttributes object

Parameters:
val - The new httpServers value

getHttpServers

String getHttpServers()
Gets the httpSrvers attribute of the LateralCacheAttributes object

Returns:
The httpServers value

setUdpMulticastAddr

void setUdpMulticastAddr(String val)
Sets the udpMulticastAddr attribute of the ILateralCacheAttributes object

Parameters:
val - The new udpMulticastAddr value

getUdpMulticastAddr

String getUdpMulticastAddr()
Gets the udpMulticastAddr attribute of the ILateralCacheAttributes object

Returns:
The udpMulticastAddr value

setUdpMulticastPort

void setUdpMulticastPort(int val)
Sets the udpMulticastPort attribute of the ILateralCacheAttributes object

Parameters:
val - The new udpMulticastPort value

getUdpMulticastPort

int getUdpMulticastPort()
Gets the udpMulticastPort attribute of the ILateralCacheAttributes object

Returns:
The udpMulticastPort value

setTransmissionType

void setTransmissionType(int val)
Sets the transmissionType attribute of the ILateralCacheAttributes object

Parameters:
val - The new transmissionType value

getTransmissionType

int getTransmissionType()
Gets the transmissionType attribute of the ILateralCacheAttributes object

Returns:
The transmissionType value

setTransmissionTypeName

void setTransmissionTypeName(String val)
Sets the transmissionTypeName attribute of the ILateralCacheAttributes object

Parameters:
val - The new transmissionTypeName value

getTransmissionTypeName

String getTransmissionTypeName()
Gets the transmissionTypeName attribute of the ILateralCacheAttributes object

Returns:
The transmissionTypeName value

setPutOnlyMode

void setPutOnlyMode(boolean val)
Sets the putOnlyMode attribute of the ILateralCacheAttributes. When this is true the lateral cache will only issue put and remove order and will not try to retrieve elements from other lateral caches.

Parameters:
val - The new transmissionTypeName value

getPutOnlyMode

boolean getPutOnlyMode()
Returns:
The outgoingOnlyMode value. Stops gets from going remote.

setReceive

void setReceive(boolean receive)
Parameters:
receive - The receive to set.

isReceive

boolean isReceive()
Should a listener be created. By default this is true.

If this is false the lateral will connect to others but it will not create a listener to receive.

It is possible if two laterals are misconfigured that lateral A may have a region R1 that is not configured for the lateral but another is. And if cache B has region R1 configured for lateral distribution, A will get messages for R1 but not send them.

Returns:
true if we should have a listener connection

setZombieQueueMaxSize

void setZombieQueueMaxSize(int zombieQueueMaxSize)
The number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.

Parameters:
zombieQueueMaxSize - The zombieQueueMaxSize to set.

getZombieQueueMaxSize

int getZombieQueueMaxSize()
The number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.

Returns:
Returns the zombieQueueMaxSize.


Copyright © 2002-2012 Apache Software Foundation. All Rights Reserved.