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

Class ExternalHttpAccessLogPublisherCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ExternalHttpAccessLogPublisherCfgClient,ExternalHttpAccessLogPublisherCfg>

org.forgerock.opendj.server.config.meta.ExternalHttpAccessLogPublisherCfgDefn

public final class ExternalHttpAccessLogPublisherCfgDefn
extends ManagedObjectDefinition<ExternalHttpAccessLogPublisherCfgClient,ExternalHttpAccessLogPublisherCfg>

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

External HTTP Access Log Publishers publish HTTP access messages to an external handler.

Method Summary

Modifier and Type	Method	Description
ExternalHttpAccessLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends ExternalHttpAccessLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
ExternalHttpAccessLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends ExternalHttpAccessLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
StringPropertyDefinition	getConfigFilePropertyDefinition()	Get the "config-file" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static ExternalHttpAccessLogPublisherCfgDefn	getInstance()	Get the External HTTP Access Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getLogFieldBlacklistPropertyDefinition()	Get the "log-field-blacklist" property definition.
StringPropertyDefinition	getLogFieldWhitelistPropertyDefinition()	Get the "log-field-whitelist" property definition.
Class<ExternalHttpAccessLogPublisherCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.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 ExternalHttpAccessLogPublisherCfgDefn getInstance()

Get the External HTTP Access Log Publisher configuration definition singleton.

Returns:

Returns the External HTTP Access Log Publisher configuration definition singleton.

createClientConfiguration

public ExternalHttpAccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends ExternalHttpAccessLogPublisherCfgClient> 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<ExternalHttpAccessLogPublisherCfgClient,ExternalHttpAccessLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ExternalHttpAccessLogPublisherCfgClient,ExternalHttpAccessLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ExternalHttpAccessLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ExternalHttpAccessLogPublisherCfgClient,ExternalHttpAccessLogPublisherCfg>

Returns:

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

getConfigFilePropertyDefinition

public StringPropertyDefinition getConfigFilePropertyDefinition()

Get the "config-file" property definition.

The JSON configuration file that defines the External HTTP Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.

Returns:

Returns the "config-file" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the External 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 External HTTP Access Log Publisher implementation.

Returns:

Returns the "java-class" property definition.

getLogFieldBlacklistPropertyDefinition

public StringPropertyDefinition getLogFieldBlacklistPropertyDefinition()

Get the "log-field-blacklist" property definition.

List of fields that the server omits from access log messages.

Valid values for this property are JSON paths for fields present in the log file.

Returns:

Returns the "log-field-blacklist" property definition.

getLogFieldWhitelistPropertyDefinition

public StringPropertyDefinition getLogFieldWhitelistPropertyDefinition()

Get the "log-field-whitelist" property definition.

List of fields that the server includes in access log messages.

Valid values for this property are JSON paths for fields present in the log file.

Returns:

Returns the "log-field-whitelist" property definition.