org.opends.server.admin.std.client
Interface NetworkGroupCfgClient

All Superinterfaces:
ConfigurationClient

public interface NetworkGroupCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Network Group settings.

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


Method Summary
 ManagedObjectDefinition<? extends NetworkGroupCfgClient,? extends NetworkGroupCfg> definition()
          Get the configuration definition 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.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setNetworkGroupId(java.lang.String value)
          Sets the "network-group-id" property.
 void setWorkflow(java.util.Collection<java.lang.String> values)
          Sets the "workflow" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends NetworkGroupCfgClient,? extends NetworkGroupCfg> definition()
Get the configuration definition associated with this Network Group.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Network Group.

isEnabled

java.lang.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.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setNetworkGroupId

void setNetworkGroupId(java.lang.String value)
                       throws IllegalPropertyValueException,
                              PropertyIsReadOnlyException
Sets 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.

This property is read-only and can only be modified during creation of a Network Group.

Parameters:
value - The value of the "network-group-id" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Network Group is not being initialized.

getWorkflow

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

Identifies the workflows in the network group.

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

setWorkflow

void setWorkflow(java.util.Collection<java.lang.String> values)
                 throws IllegalPropertyValueException,
                        PropertyIsReadOnlyException
Sets the "workflow" property.

Identifies the workflows in the network group.

This property is read-only and can only be modified during creation of a Network Group.

Parameters:
values - The values of the "workflow" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.
PropertyIsReadOnlyException - If this Network Group is not being initialized.