org.forgerock.opendj.server.config.server

Interface ExternalHTTPAccessLogPublisherCfg

All Superinterfaces:

Configuration, HTTPAccessLogPublisherCfg, LogPublisherCfg

public interface ExternalHTTPAccessLogPublisherCfg
extends HTTPAccessLogPublisherCfg

A server-side interface for querying 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
void	addExternalHTTPAccessChangeListener(ConfigurationChangeListener<ExternalHTTPAccessLogPublisherCfg> listener) Register to be notified when this External HTTP Access Log Publisher is changed.
Class<? extends ExternalHTTPAccessLogPublisherCfg>	configurationClass() Gets the configuration class associated with this External HTTP Access Log Publisher.
String	getConfigFile() Gets the "config-file" property.
String	getJavaClass() Gets the "java-class" property.
void	removeExternalHTTPAccessChangeListener(ConfigurationChangeListener<ExternalHTTPAccessLogPublisherCfg> listener) Deregister an existing External HTTP Access Log Publisher configuration change listener.

Methods inherited from interface org.forgerock.opendj.server.config.server.HTTPAccessLogPublisherCfg

addHTTPAccessChangeListener, removeHTTPAccessChangeListener

Methods inherited from interface org.forgerock.opendj.server.config.server.LogPublisherCfg

addChangeListener, isEnabled, removeChangeListener

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

dn

Method Detail

configurationClass

Class<? extends ExternalHTTPAccessLogPublisherCfg> configurationClass()

Gets the configuration class associated with this External HTTP Access Log Publisher.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HTTPAccessLogPublisherCfg

Specified by:

configurationClass in interface LogPublisherCfg

Returns:

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

addExternalHTTPAccessChangeListener

void addExternalHTTPAccessChangeListener(ConfigurationChangeListener<ExternalHTTPAccessLogPublisherCfg> listener)

Register to be notified when this External HTTP Access Log Publisher is changed.

Parameters:

listener - The External HTTP Access Log Publisher configuration change listener.

removeExternalHTTPAccessChangeListener

void removeExternalHTTPAccessChangeListener(ConfigurationChangeListener<ExternalHTTPAccessLogPublisherCfg> listener)

Deregister an existing External HTTP Access Log Publisher configuration change listener.

Parameters:

listener - The External HTTP Access Log Publisher configuration change listener.

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.

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 HTTPAccessLogPublisherCfg

Specified by:

getJavaClass in interface LogPublisherCfg

Returns:

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