Package org.apache.geode.management.configuration

Class AbstractConfiguration<R extends RuntimeInfo>

java.lang.Object
org.apache.geode.management.configuration.AbstractConfiguration<R>
Type Parameters:
R - the RuntimeInfo that corresponds to this configuration. Each non-abstract subclass needs to supply this when it extends this class.
All Implemented Interfaces:
Serializable, Identifiable<String>, JsonSerializable
Direct Known Subclasses:
GroupableConfiguration, Index, Pdx
@Experimental public abstract class AbstractConfiguration<R extends RuntimeInfo> extends Object implements Identifiable<String>, JsonSerializable
This class represents either a configuration or a filter.

As a configuration of a managed entity it can be used to either create, update, or delete it, or to describe it in the result of list or get.

As a filter as input to list or get it can be used to specify what entities to return.

See Also:

  • Field Details

    • CLUSTER

      public static final String CLUSTER
      The reserved group name that represents the predefined "cluster" group. Every member of a cluster automatically belongs to this group. Note that this cluster group name is not allowed in some contexts. For example when creating a region, instead of setting the group to CLUSTER, you need to set it to NULL or just let it default.
      See Also:

  • Constructor Details

    • AbstractConfiguration

      public AbstractConfiguration()

  • Method Details

    • isCluster

      public static boolean isCluster(String groupName)
      Returns true if the given "groupName" represents the predefined "cluster" group. This is true if "groupName" is a case-insensitive match for CLUSTER, is null, or is an empty string.
      Parameters:
      groupName - the group name to be checked
      Returns:
      true if groupName is a case-insensitive match for CLUSTER, is null, or is an empty string

    • getGroupName

      public static String getGroupName(String group)

    • getGroup

      public String getGroup()

    • getId

      public abstract String getId()
      Returns the attribute of the configuration that uniquely identifies it
      Specified by:
      getId in interface Identifiable<R extends RuntimeInfo>
      Returns:
      an identifier uniquely identifying this Object.

    • getLinks

      public abstract Links getLinks()

    • isGlobalRuntime

      public boolean isGlobalRuntime()
      Returns true if the RuntimeInfo will be the same on all members; false if each member can have different RuntimeInfo.
      Returns:
      true if the RuntimeInfo will be the same on all members

    • getCreationCommandType

      public CommandType getCreationCommandType()