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

Interface CommonAuditAccessLogPublisherCfg

All Superinterfaces:

AccessLogPublisherCfg, Configuration, LogPublisherCfg

All Known Subinterfaces:

CsvFileAccessLogPublisherCfg, ExternalAccessLogPublisherCfg, JsonFileAccessLogPublisherCfg

public interface CommonAuditAccessLogPublisherCfg
extends AccessLogPublisherCfg

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

Common Audit Access Log Publishers publish access events to commons audit.

Method Summary

Modifier and Type	Method	Description
void	addCommonAuditAccessChangeListener(ConfigurationChangeListener<CommonAuditAccessLogPublisherCfg> listener)	Register to be notified when this Common Audit Access Log Publisher is changed.
Class<? extends CommonAuditAccessLogPublisherCfg>	configurationClass()	Gets the configuration class associated with this Common Audit Access Log Publisher.
boolean	isLogControls()	Gets the "log-controls" property.
void	removeCommonAuditAccessChangeListener(ConfigurationChangeListener<CommonAuditAccessLogPublisherCfg> listener)	Deregister an existing Common Audit Access Log Publisher configuration change listener.

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

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

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 CommonAuditAccessLogPublisherCfg> configurationClass()

Gets the configuration class associated with this Common Audit Access Log Publisher.

Specified by:

configurationClass in interface AccessLogPublisherCfg

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface LogPublisherCfg

Returns:

Returns the configuration class associated with this Common Audit Access Log Publisher.

addCommonAuditAccessChangeListener

void addCommonAuditAccessChangeListener(ConfigurationChangeListener<CommonAuditAccessLogPublisherCfg> listener)

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

Parameters:

listener - The Common Audit Access Log Publisher configuration change listener.

removeCommonAuditAccessChangeListener

void removeCommonAuditAccessChangeListener(ConfigurationChangeListener<CommonAuditAccessLogPublisherCfg> listener)

Deregister an existing Common Audit Access Log Publisher configuration change listener.

Parameters:

listener - The Common Audit Access Log Publisher configuration change listener.

isLogControls

boolean isLogControls()

Gets the "log-controls" property.

Specifies whether controls with criticality and values will be included in operation log records.

Default value: true

Returns:

Returns the value of the "log-controls" property.