Package org.forgerock.opendj.server.config.meta

Class HttpAccessLogPublisherCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<HttpAccessLogPublisherCfgClient,HttpAccessLogPublisherCfg>

org.forgerock.opendj.server.config.meta.HttpAccessLogPublisherCfgDefn

public final class HttpAccessLogPublisherCfgDefn
extends ManagedObjectDefinition<HttpAccessLogPublisherCfgClient,HttpAccessLogPublisherCfg>

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

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

Method Summary

Modifier and Type	Method	Description
HttpAccessLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends HttpAccessLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
HttpAccessLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends HttpAccessLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static HttpAccessLogPublisherCfgDefn	getInstance()	Get the HTTP Access Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<HttpAccessLogPublisherCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 Details

getInstance

public static HttpAccessLogPublisherCfgDefn getInstance()

Get the HTTP Access Log Publisher configuration definition singleton.

Returns:

Returns the HTTP Access Log Publisher configuration definition singleton.

createClientConfiguration

public HttpAccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends HttpAccessLogPublisherCfgClient> impl)

Description copied from class: ManagedObjectDefinition

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<HttpAccessLogPublisherCfgClient,HttpAccessLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public HttpAccessLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends HttpAccessLogPublisherCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<HttpAccessLogPublisherCfgClient,HttpAccessLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<HttpAccessLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<HttpAccessLogPublisherCfgClient,HttpAccessLogPublisherCfg>

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 HTTP 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 HTTP Access Log Publisher implementation.

Returns:

Returns the "java-class" property definition.