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

Interface AccessLogPublisherCfg

All Superinterfaces:

Configuration, LogPublisherCfg

All Known Subinterfaces:

CsvFileAccessLogPublisherCfg, ExternalAccessLogPublisherCfg, FileBasedAccessLogPublisherCfg, FileBasedAuditLogPublisherCfg, JsonFileAccessLogPublisherCfg

public interface AccessLogPublisherCfg
extends LogPublisherCfg

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

Access Log Publishers are responsible for distributing access log messages from the access logger to a destination.

Method Summary

Modifier and Type	Method	Description
void	addAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)	Register to be notified when this Access Log Publisher is changed.
void	addAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)	Registers to be notified when new Access Log Filtering Criteria are added.
void	addAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)	Registers to be notified when existing Access Log Filtering Criteria are deleted.
Class<? extends AccessLogPublisherCfg>	configurationClass()	Gets the configuration class associated with this Access Log Publisher.
AccessLogFilteringCriteriaCfg	getAccessLogFilteringCriteria(String name)	Gets the named Access Log Filtering Criteria.
AccessLogPublisherCfgDefn.FilteringPolicy	getFilteringPolicy()	Gets the "filtering-policy" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isSuppressInternalOperations()	Gets the "suppress-internal-operations" property.
boolean	isSuppressSynchronizationOperations()	Gets the "suppress-synchronization-operations" property.
String[]	listAccessLogFilteringCriteria()	Lists the Access Log Filtering Criteria.
void	removeAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)	Deregister an existing Access Log Publisher configuration change listener.
void	removeAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)	Deregisters an existing Access Log Filtering Criteria configuration add listener.
void	removeAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)	Deregisters an existing Access Log Filtering Criteria configuration delete listener.

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 Detail

configurationClass

Class<? extends AccessLogPublisherCfg> configurationClass()

Gets the configuration class associated with this Access Log Publisher.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface LogPublisherCfg

Returns:

Returns the configuration class associated with this Access Log Publisher.

addAccessChangeListener

void addAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)

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

Parameters:

listener - The Access Log Publisher configuration change listener.

removeAccessChangeListener

void removeAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)

Deregister an existing Access Log Publisher configuration change listener.

Parameters:

listener - The Access Log Publisher configuration change listener.

getFilteringPolicy

AccessLogPublisherCfgDefn.FilteringPolicy getFilteringPolicy()

Gets the "filtering-policy" property.

Specifies how filtering criteria should be applied to log records.

Returns:

Returns the value of the "filtering-policy" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface LogPublisherCfg

Returns:

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

isSuppressInternalOperations

boolean isSuppressInternalOperations()

Gets the "suppress-internal-operations" property.

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Returns:

Returns the value of the "suppress-internal-operations" property.

isSuppressSynchronizationOperations

boolean isSuppressSynchronizationOperations()

Gets the "suppress-synchronization-operations" property.

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Returns:

Returns the value of the "suppress-synchronization-operations" property.

listAccessLogFilteringCriteria

String[] listAccessLogFilteringCriteria()

Lists the Access Log Filtering Criteria.

Returns:

Returns an array containing the names of the Access Log Filtering Criteria.

getAccessLogFilteringCriteria

AccessLogFilteringCriteriaCfg getAccessLogFilteringCriteria(String name)
                                                     throws ConfigException

Gets the named Access Log Filtering Criteria.

Parameters:

name - The name of the Access Log Filtering Criteria to retrieve.

Returns:

Returns the named Access Log Filtering Criteria.

Throws:

ConfigException - If the Access Log Filtering Criteria could not be found or it could not be successfully decoded.

addAccessLogFilteringCriteriaAddListener

void addAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)
                                       throws ConfigException

Registers to be notified when new Access Log Filtering Criteria are added.

Parameters:

listener - The Access Log Filtering Criteria configuration add listener.

Throws:

ConfigException - If the add listener could not be registered.

removeAccessLogFilteringCriteriaAddListener

void removeAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)

Deregisters an existing Access Log Filtering Criteria configuration add listener.

Parameters:

listener - The Access Log Filtering Criteria configuration add listener.

addAccessLogFilteringCriteriaDeleteListener

void addAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)
                                          throws ConfigException

Registers to be notified when existing Access Log Filtering Criteria are deleted.

Parameters:

listener - The Access Log Filtering Criteria configuration delete listener.

Throws:

ConfigException - If the delete listener could not be registered.

removeAccessLogFilteringCriteriaDeleteListener

void removeAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)

Deregisters an existing Access Log Filtering Criteria configuration delete listener.

Parameters:

listener - The Access Log Filtering Criteria configuration delete listener.