org.opends.server.admin.std.meta
Class NetworkGroupCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<NetworkGroupCfgClient,NetworkGroupCfg>
          extended by org.opends.server.admin.std.meta.NetworkGroupCfgDefn

public final class NetworkGroupCfgDefn
extends ManagedObjectDefinition<NetworkGroupCfgClient,NetworkGroupCfg>

An interface for querying the Network Group managed object definition meta information.

The Network Group is used to classify incoming connections and route requests to workflows.


Method Summary
 NetworkGroupCfgClient createClientConfiguration(ManagedObject<? extends NetworkGroupCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 NetworkGroupCfg createServerConfiguration(ServerManagedObject<? extends NetworkGroupCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static NetworkGroupCfgDefn getInstance()
          Get the Network Group configuration definition singleton.
 StringPropertyDefinition getNetworkGroupIdPropertyDefinition()
          Get the "network-group-id" property definition.
 java.lang.Class<NetworkGroupCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 AggregationPropertyDefinition<WorkflowCfgClient,WorkflowCfg> getWorkflowPropertyDefinition()
          Get the "workflow" property definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static NetworkGroupCfgDefn getInstance()
Get the Network Group configuration definition singleton.

Returns:
Returns the Network Group configuration definition singleton.

createClientConfiguration

public NetworkGroupCfgClient createClientConfiguration(ManagedObject<? extends NetworkGroupCfgClient> impl)
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:
createClientConfiguration in class ManagedObjectDefinition<NetworkGroupCfgClient,NetworkGroupCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public NetworkGroupCfg createServerConfiguration(ServerManagedObject<? extends NetworkGroupCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<NetworkGroupCfgClient,NetworkGroupCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<NetworkGroupCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<NetworkGroupCfgClient,NetworkGroupCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the Network Group is enabled for use in the server.

If a network group is not enabled, its workflows will not be accessible when processing operations.

Returns:
Returns the "enabled" property definition.

getNetworkGroupIdPropertyDefinition

public StringPropertyDefinition getNetworkGroupIdPropertyDefinition()
Get the "network-group-id" property definition.

Specifies the name that is used to identify the associated Network Group .

The name must be unique among all the Network Groups in the server.

Returns:
Returns the "network-group-id" property definition.

getWorkflowPropertyDefinition

public AggregationPropertyDefinition<WorkflowCfgClient,WorkflowCfg> getWorkflowPropertyDefinition()
Get the "workflow" property definition.

Identifies the workflows in the network group.

Returns:
Returns the "workflow" property definition.