public class RegionConfiguration extends java.lang.Object implements DataSerializable
RegionConfiguration encapsulates the configuration attributes for a Region to be
created on the server.DataSerializable.Replaceable| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_MAX_INACTIVE_INTERVAL
The default max inactive interval.
|
| Constructor and Description |
|---|
RegionConfiguration()
Default constructor used by the
DataSerialiable interface |
| Modifier and Type | Method and Description |
|---|---|
void |
fromData(java.io.DataInput in)
Reads the state of this object as primitive data from the given
DataInput. |
java.lang.String |
getCacheWriterName() |
CustomExpiry |
getCustomExpiry()
Returns the
CustomExpiry to be used |
boolean |
getEnableDebugListener()
Returns whether a debug
CacheListener is enabled. |
boolean |
getEnableGatewayDeltaReplication()
Returns whether delta replication across a
Gateway is enabled. |
boolean |
getEnableGatewayReplication()
Returns whether replication across a
Gateway is enabled. |
int |
getMaxInactiveInterval()
Returns the maximum time interval in seconds entries are expired
|
java.lang.String |
getRegionAttributesId()
Returns the id of the
RegionAttributes to be used |
java.lang.String |
getRegionName()
Returns the name of the
Region to be created |
boolean |
getSessionExpirationCacheListener() |
static void |
registerInstantiator(int id)
Registers an
Instantiator for the SessionConfiguration class |
void |
setCacheWriterName(java.lang.String cacheWriterName)
set the fully qualified name of the
CacheWriter to be created on the server. |
void |
setCustomExpiry(CustomExpiry customExpiry)
Sets the
CustomExpiry to be used |
void |
setEnableDebugListener(boolean enableDebugListener)
Enables/disables a debug
CacheListener. |
void |
setEnableGatewayDeltaReplication(boolean enableGatewayDeltaReplication)
Enables/disables delta replication across a
Gateway. |
void |
setEnableGatewayReplication(boolean enableGatewayReplication)
Enables/disables replication across a
Gateway. |
void |
setMaxInactiveInterval(int maxInactiveInterval)
Sets the maximum time interval in seconds before entries are expired
|
void |
setRegionAttributesId(java.lang.String regionAttributesId)
Sets the id of the
RegionAttributes to be used |
void |
setRegionName(java.lang.String regionName)
Sets the name of the
Region to be created |
void |
setSessionExpirationCacheListener(boolean enableSessionExpirationCacheListener) |
void |
toData(java.io.DataOutput out)
Writes the state of this object as primitive data to the given
DataOutput. |
java.lang.String |
toString() |
public static final int DEFAULT_MAX_INACTIVE_INTERVAL
public RegionConfiguration()
DataSerialiable interfacepublic void setRegionName(java.lang.String regionName)
Region to be createdregionName - The name of the Region to be createdpublic java.lang.String getRegionName()
Region to be createdRegion to be createdpublic void setRegionAttributesId(java.lang.String regionAttributesId)
RegionAttributes to be usedregionAttributesId - The id of the RegionAttributes to be usedpublic java.lang.String getRegionAttributesId()
RegionAttributes to be usedRegionAttributes to be usedpublic void setMaxInactiveInterval(int maxInactiveInterval)
maxInactiveInterval - The maximum time interval in seconds before entries are expiredpublic int getMaxInactiveInterval()
public void setCustomExpiry(CustomExpiry customExpiry)
CustomExpiry to be usedcustomExpiry - The CustomExpiry to be usedpublic CustomExpiry getCustomExpiry()
CustomExpiry to be usedCustomExpiry to be usedpublic void setEnableGatewayDeltaReplication(boolean enableGatewayDeltaReplication)
Gateway.enableGatewayDeltaReplication - true to enable, false to disable gateway delta replication.public boolean getEnableGatewayDeltaReplication()
Gateway is enabled.Gateway is enabledpublic void setEnableGatewayReplication(boolean enableGatewayReplication)
Gateway.enableGatewayReplication - true to enable, false to disable gateway replication.public boolean getEnableGatewayReplication()
Gateway is enabled.Gateway is enabledpublic void setEnableDebugListener(boolean enableDebugListener)
CacheListener.enableDebugListener - true to enable, false to disable debug CacheListener.public boolean getEnableDebugListener()
CacheListener is enabled.CacheListener is enabledpublic void setSessionExpirationCacheListener(boolean enableSessionExpirationCacheListener)
public boolean getSessionExpirationCacheListener()
public void toData(java.io.DataOutput out)
throws java.io.IOException
DataSerializableDataOutput.
Since 5.7 it is possible for any method call to the specified
DataOutput to throw GemFireRethrowable.
It should not be caught by user code.
If it is it must be rethrown.
toData in interface DataSerializablejava.io.IOException - A problem occurs while writing to outpublic void fromData(java.io.DataInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
DataSerializableDataInput.fromData in interface DataSerializablejava.io.IOException - A problem occurs while reading from injava.lang.ClassNotFoundException - A class could not be loaded while reading from
inpublic static void registerInstantiator(int id)
Instantiator for the SessionConfiguration classpublic java.lang.String toString()
toString in class java.lang.Objectpublic void setCacheWriterName(java.lang.String cacheWriterName)
CacheWriter to be created on the server. The cacheWriter must have a
zero arg constructor, and must be present on the classpath on the server.cacheWriterName - fully qualified class name of the cacheWriterpublic java.lang.String getCacheWriterName()