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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<LDIFConnectionHandlerCfgClient,LDIFConnectionHandlerCfg>
          extended by org.opends.server.admin.std.meta.LDIFConnectionHandlerCfgDefn

public final class LDIFConnectionHandlerCfgDefn
extends ManagedObjectDefinition<LDIFConnectionHandlerCfgClient,LDIFConnectionHandlerCfg>

An interface for querying the LDIF Connection Handler managed object definition meta information.

The LDIF Connection Handler is used to process changes in the server using internal operations, where the changes to process are read from an LDIF file.


Method Summary
 LDIFConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends LDIFConnectionHandlerCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 LDIFConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends LDIFConnectionHandlerCfg> impl)
          Creates a server configuration view of the provided server managed object.
 IPAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
          Get the "allowed-client" property definition.
 IPAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()
          Get the "denied-client" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static LDIFConnectionHandlerCfgDefn getInstance()
          Get the LDIF Connection Handler configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 StringPropertyDefinition getLDIFDirectoryPropertyDefinition()
          Get the "ldif-directory" property definition.
 DurationPropertyDefinition getPollIntervalPropertyDefinition()
          Get the "poll-interval" property definition.
 java.lang.Class<LDIFConnectionHandlerCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object 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 LDIFConnectionHandlerCfgDefn getInstance()
Get the LDIF Connection Handler configuration definition singleton.

Returns:
Returns the LDIF Connection Handler configuration definition singleton.

createClientConfiguration

public LDIFConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends LDIFConnectionHandlerCfgClient> 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<LDIFConnectionHandlerCfgClient,LDIFConnectionHandlerCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

getServerConfigurationClass

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

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

getAllowedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
Get the "allowed-client" property definition.

Specifies a set of address masks that determines the addresses of the clients that are allowed to establish connections to this connection handler.

Returns:
Returns the "allowed-client" property definition.

getDeniedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()
Get the "denied-client" property definition.

Specifies a set of address masks that determines the addresses of the clients that are not allowed to establish connections to this connection handler.

If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed.

Returns:
Returns the "denied-client" property definition.

getEnabledPropertyDefinition

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

Indicates whether the LDIF Connection Handler is enabled.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the LDIF Connection Handler implementation.

Returns:
Returns the "java-class" property definition.

getLDIFDirectoryPropertyDefinition

public StringPropertyDefinition getLDIFDirectoryPropertyDefinition()
Get the "ldif-directory" property definition.

Specifies the path to the directory in which the LDIF files should be placed.

Returns:
Returns the "ldif-directory" property definition.

getPollIntervalPropertyDefinition

public DurationPropertyDefinition getPollIntervalPropertyDefinition()
Get the "poll-interval" property definition.

Specifies how frequently the LDIF connection handler should check the LDIF directory to determine whether a new LDIF file has been added.

Returns:
Returns the "poll-interval" property definition.