Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.jcs.auxiliary.lateral
Class LateralCacheAttributes

java.lang.Object
  extended by org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes
      extended by org.apache.jcs.auxiliary.lateral.LateralCacheAttributes
All Implemented Interfaces:
Serializable, Cloneable, AuxiliaryCacheAttributes, ILateralCacheAttributes
Direct Known Subclasses:
TCPLateralCacheAttributes
public class LateralCacheAttributes
extends AbstractAuxiliaryCacheAttributes
implements Serializable, ILateralCacheAttributes

This class stores attributes for all of the available lateral cache auxiliaries.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes
cacheName, eventQueuePoolName, eventQueueType, name
 
Fields inherited from interface org.apache.jcs.auxiliary.lateral.behavior.ILateralCacheAttributes
DEFAULT_ZOMBIE_QUEUE_MAX_SIZE, HTTP, TCP, UDP, XMLRPC
 
Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE
 
Constructor Summary
LateralCacheAttributes()
           
 
Method Summary
 AuxiliaryCacheAttributes copy()
          Returns a clone of the attributes.
 int getHttpListenerPort()
          Gets the httpListenerPort attribute of the ILateralCacheAttributes object
 String getHttpServer()
          Gets the httpServer attribute of the LateralCacheAttributes object
 String getHttpServers()
          Gets the httpSrvers attribute of the LateralCacheAttributes object
 boolean getPutOnlyMode()
           
 int getTransmissionType()
          Gets the transmissionType attribute of the LateralCacheAttributes object
 String getTransmissionTypeName()
          Gets the transmissionTypeName attribute of the LateralCacheAttributes object
 String getUdpMulticastAddr()
          Gets the udpMulticastAddr attribute of the LateralCacheAttributes object
 int getUdpMulticastPort()
          Gets the udpMulticastPort attribute of the LateralCacheAttributes 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 LateralCacheAttributes object
 void setHttpServers(String val)
          Sets the httpServers attribute of the LateralCacheAttributes object
 void setPutOnlyMode(boolean val)
          Sets the outgoingOnlyMode attribute of the ILateralCacheAttributes.
 void setReceive(boolean receive)
           
 void setTransmissionType(int val)
          Sets the transmissionType attribute of the LateralCacheAttributes object
 void setTransmissionTypeName(String val)
          Sets the transmissionTypeName attribute of the LateralCacheAttributes object
 void setUdpMulticastAddr(String val)
          Sets the udpMulticastAddr attribute of the LateralCacheAttributes object
 void setUdpMulticastPort(int val)
          Sets the udpMulticastPort attribute of the LateralCacheAttributes object
 void setZombieQueueMaxSize(int zombieQueueMaxSize)
          The number of elements the zombie queue will hold.
 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
 

Constructor Detail

LateralCacheAttributes

public LateralCacheAttributes()
Method Detail

setHttpServer

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

Specified by:
setHttpServer in interface ILateralCacheAttributes
Parameters:
val - The new httpServer value

getHttpServer

public String getHttpServer()
Gets the httpServer attribute of the LateralCacheAttributes object

Specified by:
getHttpServer in interface ILateralCacheAttributes
Returns:
The httpServer value

setHttpServers

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

Specified by:
setHttpServers in interface ILateralCacheAttributes
Parameters:
val - The new httpServers value

getHttpServers

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

Specified by:
getHttpServers in interface ILateralCacheAttributes
Returns:
The httpServers value

setHttpListenerPort

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

Specified by:
setHttpListenerPort in interface ILateralCacheAttributes
Parameters:
val - The new tcpListenerPort value

getHttpListenerPort

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

Specified by:
getHttpListenerPort in interface ILateralCacheAttributes
Returns:
The httpListenerPort value

setUdpMulticastAddr

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

Specified by:
setUdpMulticastAddr in interface ILateralCacheAttributes
Parameters:
val - The new udpMulticastAddr value

getUdpMulticastAddr

public String getUdpMulticastAddr()
Gets the udpMulticastAddr attribute of the LateralCacheAttributes object

Specified by:
getUdpMulticastAddr in interface ILateralCacheAttributes
Returns:
The udpMulticastAddr value

setUdpMulticastPort

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

Specified by:
setUdpMulticastPort in interface ILateralCacheAttributes
Parameters:
val - The new udpMulticastPort value

getUdpMulticastPort

public int getUdpMulticastPort()
Gets the udpMulticastPort attribute of the LateralCacheAttributes object

Specified by:
getUdpMulticastPort in interface ILateralCacheAttributes
Returns:
The udpMulticastPort value

setTransmissionType

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

Specified by:
setTransmissionType in interface ILateralCacheAttributes
Parameters:
val - The new transmissionType value

getTransmissionType

public int getTransmissionType()
Gets the transmissionType attribute of the LateralCacheAttributes object

Specified by:
getTransmissionType in interface ILateralCacheAttributes
Returns:
The transmissionType value

setTransmissionTypeName

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

Specified by:
setTransmissionTypeName in interface ILateralCacheAttributes
Parameters:
val - The new transmissionTypeName value

getTransmissionTypeName

public String getTransmissionTypeName()
Gets the transmissionTypeName attribute of the LateralCacheAttributes object

Specified by:
getTransmissionTypeName in interface ILateralCacheAttributes
Returns:
The transmissionTypeName value

setPutOnlyMode

public void setPutOnlyMode(boolean val)
Sets the outgoingOnlyMode 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.

Specified by:
setPutOnlyMode in interface ILateralCacheAttributes
Parameters:
val - The new transmissionTypeName value

getPutOnlyMode

public boolean getPutOnlyMode()
Specified by:
getPutOnlyMode in interface ILateralCacheAttributes
Returns:
The outgoingOnlyMode value. Stops gets from going remote.

copy

public AuxiliaryCacheAttributes copy()
Returns a clone of the attributes.

Specified by:
copy in interface AuxiliaryCacheAttributes
Returns:
Self

setReceive

public void setReceive(boolean receive)
Specified by:
setReceive in interface ILateralCacheAttributes
Parameters:
receive - The receive to set.

isReceive

public boolean isReceive()
Description copied from interface: ILateralCacheAttributes
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.

Specified by:
isReceive in interface ILateralCacheAttributes
Returns:
Returns the receive.

setZombieQueueMaxSize

public 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.

Specified by:
setZombieQueueMaxSize in interface ILateralCacheAttributes
Parameters:
zombieQueueMaxSize - The zombieQueueMaxSize to set.

getZombieQueueMaxSize

public 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.

Specified by:
getZombieQueueMaxSize in interface ILateralCacheAttributes
Returns:
Returns the zombieQueueMaxSize.

toString

public String toString()
Overrides:
toString in class Object
Returns:
debug string.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.