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

Interface ExternalAccessLogPublisherCfg

All Superinterfaces:

AccessLogPublisherCfg, CommonAuditAccessLogPublisherCfg, Configuration, LogPublisherCfg

public interface ExternalAccessLogPublisherCfg
extends CommonAuditAccessLogPublisherCfg

A server-side interface for querying External Access Log Publisher settings.

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

Method Summary

Modifier and Type	Method	Description
void	addExternalAccessChangeListener(ConfigurationChangeListener<ExternalAccessLogPublisherCfg> listener)	Register to be notified when this External Access Log Publisher is changed.
Class<? extends ExternalAccessLogPublisherCfg>	configurationClass()	Gets the configuration class associated with this External Access Log Publisher.
String	getConfigFile()	Gets the "config-file" property.
String	getJavaClass()	Gets the "java-class" property.
SortedSet<String>	getLogFieldBlacklist()	Gets the "log-field-blacklist" property.
void	removeExternalAccessChangeListener(ConfigurationChangeListener<ExternalAccessLogPublisherCfg> listener)	Deregister an existing External Access Log Publisher configuration change listener.

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

addAccessChangeListener, addAccessLogFilteringCriteriaAddListener, addAccessLogFilteringCriteriaDeleteListener, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessChangeListener, removeAccessLogFilteringCriteriaAddListener, removeAccessLogFilteringCriteriaDeleteListener

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

addCommonAuditAccessChangeListener, isLogControls, removeCommonAuditAccessChangeListener

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

dn, name

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

addChangeListener, isEnabled, removeChangeListener

Method Details

configurationClass

Class<? extends ExternalAccessLogPublisherCfg> configurationClass()

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

Specified by:

configurationClass in interface AccessLogPublisherCfg

Specified by:

configurationClass in interface CommonAuditAccessLogPublisherCfg

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface LogPublisherCfg

Returns:

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

addExternalAccessChangeListener

void addExternalAccessChangeListener(ConfigurationChangeListener<ExternalAccessLogPublisherCfg> listener)

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

Parameters:

listener - The External Access Log Publisher configuration change listener.

removeExternalAccessChangeListener

void removeExternalAccessChangeListener(ConfigurationChangeListener<ExternalAccessLogPublisherCfg> listener)

Deregister an existing External Access Log Publisher configuration change listener.

Parameters:

listener - The External Access Log Publisher configuration change listener.

getConfigFile

String getConfigFile()

Gets the "config-file" property.

The JSON configuration file that defines the External 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.

Default value is undefined

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

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

Specified by:

getJavaClass in interface AccessLogPublisherCfg

Specified by:

getJavaClass in interface LogPublisherCfg

Returns:

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

getLogFieldBlacklist

SortedSet<String> getLogFieldBlacklist()

Gets the "log-field-blacklist" property.

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 an unmodifiable set containing the values of the "log-field-blacklist" property.