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

Interface ExternalAccessLogPublisherCfgClient

All Superinterfaces:

AccessLogPublisherCfgClient, CommonAuditAccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

public interface ExternalAccessLogPublisherCfgClient
extends CommonAuditAccessLogPublisherCfgClient

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

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

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends ExternalAccessLogPublisherCfgClient,? extends ExternalAccessLogPublisherCfg>	definition()	Get the configuration definition associated with this External Access Log Publisher.
ValueOrExpression<String>	getConfigFile()	Gets the "config-file" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<String>>	getLogFieldBlacklist()	Gets the "log-field-blacklist" property.
void	setConfigFile(ValueOrExpression<String> value)	Sets the "config-file" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setLogFieldBlacklist(Collection<ValueOrExpression<String>> values)	Sets the "log-field-blacklist" property.

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

createAccessLogFilteringCriteria, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessLogFilteringCriteria, setFilteringPolicy, setSuppressInternalOperations, setSuppressSynchronizationOperations

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

isLogControls, setLogControls

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

commit, properties

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

isEnabled, setEnabled

Method Details

definition

ManagedObjectDefinition<? extends ExternalAccessLogPublisherCfgClient,? extends ExternalAccessLogPublisherCfg> definition()

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

Specified by:

definition in interface AccessLogPublisherCfgClient

Specified by:

definition in interface CommonAuditAccessLogPublisherCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

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

getConfigFile

@MandatoryProperty
ValueOrExpression<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.

setConfigFile

@MandatoryProperty
void setConfigFile(ValueOrExpression<String> value)
            throws PropertyException

Sets 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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<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 AccessLogPublisherCfgClient

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface AccessLogPublisherCfgClient

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getLogFieldBlacklist

SortedSet<ValueOrExpression<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 the values of the "log-field-blacklist" property.

setLogFieldBlacklist

void setLogFieldBlacklist(Collection<ValueOrExpression<String>> values)
                   throws PropertyException

Sets 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.

Parameters:

values - The values of the "log-field-blacklist" property.

Throws:

PropertyException - If one or more of the new values are invalid.