Package org.apache.geode.cache

Class MembershipAttributes

  • All Implemented Interfaces:
    Externalizable, Serializable, DataSerializable
    @Deprecated
public class MembershipAttributes
extends Object
implements DataSerializable, Externalizable
    Deprecated.
    this feature is scheduled to be removed
    Configuration attributes for defining reliability requirements and behavior for a Region.

    MembershipAttributes provides options for configuring a Region to require one or more membership roles to be present in the system for reliable access to the Region. Each Role is a user defined string name, such as Producer or Backup or FooProducer.

    The LossAction defines the behavior when one or more required roles are missing.

    The ResumptionAction specifies the action to be taken when reliability resumes.

    MembershipAttributes have no effect unless one or more required roles are specified. These attributes are immutable after the Region has been created.

    See Also:
    Serialized Form

    • Constructor Detail

      • MembershipAttributes

        public MembershipAttributes()
        Deprecated.
        Creates a new MembershipAttributes with the default configuration of no required roles.

      • MembershipAttributes

        public MembershipAttributes​(String[] requiredRoles)
        Deprecated.
        Creates a new MembershipAttributes with the specified required role names. Reliability policy will default to NO_ACCESS, and resumption action will default to REINITIALIZE.
        Parameters:
        requiredRoles - array of role names required by this process for reliable access to the region
        Throws:
        IllegalArgumentException - if no requiredRoles are specified

      • MembershipAttributes

        public MembershipAttributes​(String[] requiredRoles,
                            LossAction lossAction,
                            ResumptionAction resumptionAction)
        Deprecated.
        Creates a new MembershipAttributes with the specified required role names, reliability policy, and resumption action.
        Parameters:
        requiredRoles - array of role names required by this process for reliable access to the region
        lossAction - the configuration defining how this process behaves when there are missing required roles
        resumptionAction - the action to take when missing required roles return to the system
        Throws:
        IllegalArgumentException - if the resumptionAction is incompatible with the lossAction or if no requiredRoles are specified

    • Method Detail

      • getRequiredRoles

        public Set<Role> getRequiredRoles()
        Deprecated.
        Returns the set of Roles that are required for the reliability of this region.
        Returns:
        the set of Roles that are required for the reliability of this region

      • hasRequiredRoles

        public boolean hasRequiredRoles()
        Deprecated.
        Returns true if there are one or more required roles specified.
        Returns:
        whether there are one or more required roles specified

      • getLossAction

        public LossAction getLossAction()
        Deprecated.
        Returns the reliability policy that describes behavior if any required roles are missing.
        Returns:
        the reliability policy that describes behavior if any required roles are missing

      • getResumptionAction

        public ResumptionAction getResumptionAction()
        Deprecated.
        Returns the resumption action that describes behavior when missing required roles return to the system
        Returns:
        the resumption action that describes behavior when missing required roles return to the system

      • equals

        public boolean equals​(Object other)
        Deprecated.
        Indicates whether some other object is "equal to" this one.
        Overrides:
        equals in class Object
        Parameters:
        other - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.

      • hashCode

        public int hashCode()
        Deprecated.
        Returns a hash code for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
        Overrides:
        hashCode in class Object
        Returns:
        the integer 0 if description is null; otherwise a unique integer.

      • toString

        public String toString()
        Deprecated.
        Returns a string representation of the object.
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object

      • toData

        public void toData​(DataOutput out)
            throws IOException
        Deprecated.
        Description copied from interface: DataSerializable
        Writes the state of this object as primitive data to the given DataOutput.

        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.

        Specified by:
        toData in interface DataSerializable
        Parameters:
        out - the DataOutput to write to
        Throws:
        IOException - A problem occurs while writing to out