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

Interface ExternalAccessLogPublisherCfgClient

All Superinterfaces:

AccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

public interface ExternalAccessLogPublisherCfgClient
extends AccessLogPublisherCfgClient

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.
String	getConfigFile()	Gets the "config-file" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isLogControlOids()	Gets the "log-control-oids" property.
void	setConfigFile(String value)	Sets the "config-file" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setLogControlOids(Boolean value)	Sets the "log-control-oids" 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.config.ConfigurationClient

commit, properties

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

isEnabled, setEnabled

Method Detail

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 ConfigurationClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

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

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.

Returns:

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

setConfigFile

void setConfigFile(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

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface AccessLogPublisherCfgClient

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

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

setJavaClass

void setJavaClass(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.

isLogControlOids

boolean isLogControlOids()

Gets the "log-control-oids" property.

Specifies whether control OIDs will be included in operation log records.

Returns:

Returns the value of the "log-control-oids" property.

setLogControlOids

void setLogControlOids(Boolean value)
                throws PropertyException

Sets the "log-control-oids" property.

Specifies whether control OIDs will be included in operation log records.

Parameters:

value - The value of the "log-control-oids" property.

Throws:

PropertyException - If the new value is invalid.