GemFire 5.7.1

com.gemstone.gemfire.cache
Class LossAction

java.lang.Object
  extended by com.gemstone.gemfire.cache.LossAction
All Implemented Interfaces:
Serializable

public class LossAction
extends Object
implements Serializable

Specifies how access to the region is affected when one or more required roles are lost. A role is lost when it is are offline and no longer present in the system membership. The LossAction is specified when configuring a region's MembershipAttributes.

Since:
5.0
See Also:
Serialized Form

Field Summary
static LossAction FULL_ACCESS
          Access to the region is unaffected when required roles are missing.
static LossAction LIMITED_ACCESS
          Only local access to the region is allowed when required roles are missing.
static LossAction NO_ACCESS
          The region is unavailable when required roles are missing.
 byte ordinal
          byte used as ordinal to represent this Scope
static LossAction RECONNECT
          Loss of required roles causes the entire cache to be closed.
static List VALUES
          List of all LossAction values
 
Method Summary
static LossAction fromName(String name)
          Return the LossAction specified by name
static LossAction fromOrdinal(byte ordinal)
          Return the LossAction represented by specified ordinal
 boolean isAllAccess()
          Returns true if this is FULL_ACCESS.
 boolean isLimitedAccess()
          Returns true if this is LIMITED_ACCESS.
 boolean isNoAccess()
          Returns true if this is NO_ACCESS.
 boolean isReconnect()
          Returns true if this is RECONNECT.
 String toString()
          Returns a string representation for this loss action.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_ACCESS

public static final LossAction NO_ACCESS
The region is unavailable when required roles are missing. All operations including read and write access are denied. All read and write operations on the region will result in RegionAccessException while any required roles are absent. Basic administration of the region is allowed, including close and localDestroyRegion.


LIMITED_ACCESS

public static final LossAction LIMITED_ACCESS
Only local access to the region is allowed when required roles are missing. All distributed write operations on the region will throw RegionAccessException while any required roles are absent. Reads which result in a netSearch behave normally, while any attempt to invoke a netLoad is not allowed.


FULL_ACCESS

public static final LossAction FULL_ACCESS
Access to the region is unaffected when required roles are missing.


RECONNECT

public static final LossAction RECONNECT
Loss of required roles causes the entire cache to be closed. In addition, this process will disconnect from the DistributedSystem and then reconnect. Attempting to use any existing references to the regions or cache will throw a CacheClosedException.


ordinal

public final byte ordinal
byte used as ordinal to represent this Scope


VALUES

public static final List VALUES
List of all LossAction values

Method Detail

fromOrdinal

public static LossAction fromOrdinal(byte ordinal)
Return the LossAction represented by specified ordinal


fromName

public static LossAction fromName(String name)
Return the LossAction specified by name


isNoAccess

public boolean isNoAccess()
Returns true if this is NO_ACCESS.


isLimitedAccess

public boolean isLimitedAccess()
Returns true if this is LIMITED_ACCESS.


isAllAccess

public boolean isAllAccess()
Returns true if this is FULL_ACCESS.


isReconnect

public boolean isReconnect()
Returns true if this is RECONNECT.


toString

public String toString()
Returns a string representation for this loss action.

Overrides:
toString in class Object
Returns:
the name of this loss action

GemFire 5.7.1

Copyright © 2002-2008 GemStone Systems, Inc. All Rights Reserved.