org.forgerock.opendj.server.config.client

Interface ExternalHTTPAccessLogPublisherCfgClient

All Superinterfaces:

ConfigurationClient, HTTPAccessLogPublisherCfgClient, LogPublisherCfgClient

public interface ExternalHTTPAccessLogPublisherCfgClient
extends HTTPAccessLogPublisherCfgClient

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

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

Method Summary

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends ExternalHTTPAccessLogPublisherCfgClient,? extends ExternalHTTPAccessLogPublisherCfg>	definition() Get the configuration definition associated with this External HTTP Access Log Publisher.
String	getConfigFile() Gets the "config-file" property.
String	getJavaClass() Gets the "java-class" property.
void	setConfigFile(String value) Sets the "config-file" property.
void	setJavaClass(String value) Sets the "java-class" property.

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

isEnabled, setEnabled

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends ExternalHTTPAccessLogPublisherCfgClient,? extends ExternalHTTPAccessLogPublisherCfg> definition()

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

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HTTPAccessLogPublisherCfgClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

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

getConfigFile

String getConfigFile()

Gets the "config-file" property.

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 value of the "config-file" property.

setConfigFile

void setConfigFile(String value)
                   throws PropertyException

Sets the "config-file" property.

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.

Parameters:

value - The value of the "config-file" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface HTTPAccessLogPublisherCfgClient

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
                  throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface HTTPAccessLogPublisherCfgClient

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.