Package org.apache.geode.modules.util
Class RegionConfiguration
java.lang.Object
org.apache.geode.modules.util.RegionConfiguration
- All Implemented Interfaces:
Serializable,DataSerializable
Class
RegionConfiguration encapsulates the configuration attributes for a
Region to be created on the server.- Since:
- GemFire 6.5
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.geode.DataSerializable
DataSerializable.Replaceable -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe default max inactive interval. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor used by theDataSerialiableinterface -
Method Summary
Modifier and TypeMethodDescriptionvoidReads the state of this object as primitive data from the givenDataInput.intReturns the maximum time interval in seconds entries are expiredReturns the name of theRegionto be createdvoidsetCustomExpiry(CustomExpiry customExpiry) Sets theCustomExpiryto be usedvoidsetEnableDebugListener(boolean enableDebugListener) Enables/disables a debugCacheListener.voidsetEnableGatewayDeltaReplication(boolean enableGatewayDeltaReplication) Enables/disables delta replication across aGateway.voidsetEnableGatewayReplication(boolean enableGatewayReplication) Enables/disables replication across aGateway.voidsetMaxInactiveInterval(int maxInactiveInterval) Sets the maximum time interval in seconds before entries are expiredvoidsetRegionAttributesId(String regionAttributesId) Sets the id of theRegionAttributesto be usedvoidsetRegionName(String regionName) Sets the name of theRegionto be createdvoidsetSessionExpirationCacheListener(boolean enableSessionExpirationCacheListener) voidtoData(DataOutput out) Writes the state of this object as primitive data to the givenDataOutput.toString()
-
Field Details
-
DEFAULT_MAX_INACTIVE_INTERVAL
public static final int DEFAULT_MAX_INACTIVE_INTERVALThe default max inactive interval. The default value is -1.- See Also:
-
-
Constructor Details
-
RegionConfiguration
public RegionConfiguration()Default constructor used by theDataSerialiableinterface
-
-
Method Details
-
setRegionName
Sets the name of theRegionto be created- Parameters:
regionName- The name of theRegionto be created
-
getRegionName
Returns the name of theRegionto be created- Returns:
- the name of the
Regionto be created
-
setRegionAttributesId
Sets the id of theRegionAttributesto be used- Parameters:
regionAttributesId- The id of theRegionAttributesto be used
-
setMaxInactiveInterval
public void setMaxInactiveInterval(int maxInactiveInterval) Sets the maximum time interval in seconds before entries are expired- Parameters:
maxInactiveInterval- The maximum time interval in seconds before entries are expired
-
getMaxInactiveInterval
public int getMaxInactiveInterval()Returns the maximum time interval in seconds entries are expired- Returns:
- the maximum time interval in seconds before entries are expired
-
setCustomExpiry
Sets theCustomExpiryto be used- Parameters:
customExpiry- TheCustomExpiryto be used
-
setEnableGatewayDeltaReplication
public void setEnableGatewayDeltaReplication(boolean enableGatewayDeltaReplication) Enables/disables delta replication across aGateway.- Parameters:
enableGatewayDeltaReplication- true to enable, false to disable gateway delta replication.
-
setEnableGatewayReplication
public void setEnableGatewayReplication(boolean enableGatewayReplication) Enables/disables replication across aGateway.- Parameters:
enableGatewayReplication- true to enable, false to disable gateway replication.
-
setEnableDebugListener
public void setEnableDebugListener(boolean enableDebugListener) Enables/disables a debugCacheListener.- Parameters:
enableDebugListener- true to enable, false to disable debugCacheListener.
-
setSessionExpirationCacheListener
public void setSessionExpirationCacheListener(boolean enableSessionExpirationCacheListener) -
toData
Description copied from interface:DataSerializableWrites the state of this object as primitive data to the givenDataOutput.Since 5.7 it is possible for any method call to the specified
DataOutputto throwGemFireRethrowable. It should not be caught by user code. If it is it must be rethrown.- Specified by:
toDatain interfaceDataSerializable- Parameters:
out- theDataOutputto write to- Throws:
IOException- A problem occurs while writing toout
-
fromData
Description copied from interface:DataSerializableReads the state of this object as primitive data from the givenDataInput.- Specified by:
fromDatain interfaceDataSerializable- Parameters:
in- theDataInputto read from- Throws:
IOException- A problem occurs while reading frominClassNotFoundException- A class could not be loaded while reading fromin
-
toString
-