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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>
          extended by org.opends.server.admin.std.meta.AccessLogPublisherCfgDefn

public final class AccessLogPublisherCfgDefn
extends ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>

An interface for querying the Access Log Publisher managed object definition meta information.

Access Log Publishers are responsible for distributing access log messages from the access logger to a destination.


Method Summary
 AccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends AccessLogPublisherCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 AccessLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends AccessLogPublisherCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static AccessLogPublisherCfgDefn getInstance()
          Get the Access Log Publisher configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<AccessLogPublisherCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 BooleanPropertyDefinition getSuppressInternalOperationsPropertyDefinition()
          Get the "suppress-internal-operations" property definition.
 BooleanPropertyDefinition getSuppressSynchronizationOperationsPropertyDefinition()
          Get the "suppress-synchronization-operations" 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 AccessLogPublisherCfgDefn getInstance()
Get the Access Log Publisher configuration definition singleton.

Returns:
Returns the Access Log Publisher configuration definition singleton.

createClientConfiguration

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

createServerConfiguration

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

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

getServerConfigurationClass

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

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>
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 Access Log Publisher is enabled for use.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

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

The fully-qualified name of the Java class that provides the Access Log Publisher implementation.

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

getSuppressInternalOperationsPropertyDefinition

public BooleanPropertyDefinition getSuppressInternalOperationsPropertyDefinition()
Get the "suppress-internal-operations" property definition.

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Returns:
Returns the "suppress-internal-operations" property definition.

getSuppressSynchronizationOperationsPropertyDefinition

public BooleanPropertyDefinition getSuppressSynchronizationOperationsPropertyDefinition()
Get the "suppress-synchronization-operations" property definition.

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Returns:
Returns the "suppress-synchronization-operations" property definition.