Package org.forgerock.opendj.server.config.client

Interface HttpAccessLogPublisherCfgClient

All Superinterfaces:

ConfigurationClient, LogPublisherCfgClient

All Known Subinterfaces:

CsvFileHttpAccessLogPublisherCfgClient, ExternalHttpAccessLogPublisherCfgClient, FileBasedHttpAccessLogPublisherCfgClient, JsonFileHttpAccessLogPublisherCfgClient

public interface HttpAccessLogPublisherCfgClient
extends LogPublisherCfgClient

A client-side interface for reading and modifying HTTP Access Log Publisher settings.

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
ManagedObjectDefinition<? extends HttpAccessLogPublisherCfgClient,? extends HttpAccessLogPublisherCfg>	definition()	Get the configuration definition associated with this HTTP Access Log Publisher.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.LogPublisherCfgClient

isEnabled, setEnabled

Method Details

definition

ManagedObjectDefinition<? extends HttpAccessLogPublisherCfgClient,? extends HttpAccessLogPublisherCfg> definition()

Get the configuration definition associated with this HTTP Access Log Publisher.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

Returns the configuration definition associated with this HTTP Access Log Publisher.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.loggers.HTTPAccessLogPublisher

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.