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

Interface JsonFileAccessLogPublisherCfgClient

All Superinterfaces:

AccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

public interface JsonFileAccessLogPublisherCfgClient
extends AccessLogPublisherCfgClient

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

Json File Access Log Publishers Publish access messages to Json files.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends JsonFileAccessLogPublisherCfgClient,? extends JsonFileAccessLogPublisherCfg>	definition()	Get the configuration definition associated with this Json File Access Log Publisher.
String	getJavaClass()	Gets the "java-class" property.
String	getLogDirectory()	Gets the "log-directory" property.
SortedSet<String>	getRetentionPolicy()	Gets the "retention-policy" property.
SortedSet<String>	getRotationPolicy()	Gets the "rotation-policy" property.
boolean	isLogControlOids()	Gets the "log-control-oids" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setLogControlOids(Boolean value)	Sets the "log-control-oids" property.
void	setLogDirectory(String value)	Sets the "log-directory" property.
void	setRetentionPolicy(Collection<String> values)	Sets the "retention-policy" property.
void	setRotationPolicy(Collection<String> values)	Sets the "rotation-policy" 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 JsonFileAccessLogPublisherCfgClient,? extends JsonFileAccessLogPublisherCfg> definition()

Get the configuration definition associated with this Json File 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 Json File Access Log Publisher.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

The fully-qualified name of the Java class that provides the Json File 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 Json File 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.

getLogDirectory

String getLogDirectory()

Gets the "log-directory" property.

The directory to use for the log files generated by the Json File Access Log Publisher. The path to the directory is relative to the server root.

Returns:

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

setLogDirectory

void setLogDirectory(String value)
              throws PropertyException

Sets the "log-directory" property.

The directory to use for the log files generated by the Json File Access Log Publisher. The path to the directory is relative to the server root.

Parameters:

value - The value of the "log-directory" property.

Throws:

PropertyException - If the new value is invalid.

getRetentionPolicy

SortedSet<String> getRetentionPolicy()

Gets the "retention-policy" property.

The retention policy to use for the Json File Access Log Publisher.

When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

Returns:

Returns the values of the "retention-policy" property.

setRetentionPolicy

void setRetentionPolicy(Collection<String> values)
                 throws PropertyException

Sets the "retention-policy" property.

The retention policy to use for the Json File Access Log Publisher.

When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

Parameters:

values - The values of the "retention-policy" property.

Throws:

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

getRotationPolicy

SortedSet<String> getRotationPolicy()

Gets the "rotation-policy" property.

The rotation policy to use for the Json File Access Log Publisher.

When multiple policies are used, rotation will occur if any policy's conditions are met.

Returns:

Returns the values of the "rotation-policy" property.

setRotationPolicy

void setRotationPolicy(Collection<String> values)
                throws PropertyException

Sets the "rotation-policy" property.

The rotation policy to use for the Json File Access Log Publisher.

When multiple policies are used, rotation will occur if any policy's conditions are met.

Parameters:

values - The values of the "rotation-policy" property.

Throws:

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