org.opends.server.admin.std.server
Interface NetworkGroupCfg

All Superinterfaces:
Configuration

public interface NetworkGroupCfg
extends Configuration

A server-side interface for querying Network Group settings.

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


Method Summary
 void addChangeListener(ConfigurationChangeListener<NetworkGroupCfg> listener)
          Register to be notified when this Network Group is changed.
 java.lang.Class<? extends NetworkGroupCfg> configurationClass()
          Gets the configuration class associated with this Network Group.
 java.lang.String getNetworkGroupId()
          Gets the "network-group-id" property.
 java.util.SortedSet<java.lang.String> getWorkflow()
          Gets the "workflow" property.
 java.util.SortedSet<DN> getWorkflowDNs()
          Gets the "workflow" property as a set of DNs.
 boolean isEnabled()
          Gets the "enabled" property.
 void removeChangeListener(ConfigurationChangeListener<NetworkGroupCfg> listener)
          Deregister an existing Network Group configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends NetworkGroupCfg> configurationClass()
Gets the configuration class associated with this Network Group.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Network Group.

addChangeListener

void addChangeListener(ConfigurationChangeListener<NetworkGroupCfg> listener)
Register to be notified when this Network Group is changed.

Parameters:
listener - The Network Group configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<NetworkGroupCfg> listener)
Deregister an existing Network Group configuration change listener.

Parameters:
listener - The Network Group configuration change listener.

isEnabled

boolean isEnabled()
Gets the "enabled" property.

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 value of the "enabled" property.

getNetworkGroupId

java.lang.String getNetworkGroupId()
Gets the "network-group-id" property.

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 value of the "network-group-id" property.

getWorkflow

java.util.SortedSet<java.lang.String> getWorkflow()
Gets the "workflow" property.

Identifies the workflows in the network group.

Returns:
Returns an unmodifiable set containing the values of the "workflow" property.

getWorkflowDNs

java.util.SortedSet<DN> getWorkflowDNs()
Gets the "workflow" property as a set of DNs.

Identifies the workflows in the network group.

Returns:
Returns the DN values of the "workflow" property.