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

Interface FileBasedAccessLogPublisherCfgClient

All Superinterfaces:

AccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

public interface FileBasedAccessLogPublisherCfgClient
extends AccessLogPublisherCfgClient

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

File Based Access Log Publishers publish access messages to the file system.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FileBasedAccessLogPublisherCfgClient,? extends FileBasedAccessLogPublisherCfg>	definition()	Get the configuration definition associated with this File Based Access Log Publisher.
long	getBufferSize()	Gets the "buffer-size" property.
String	getJavaClass()	Gets the "java-class" property.
String	getLogFile()	Gets the "log-file" property.
String	getLogFilePermissions()	Gets the "log-file-permissions" property.
FileBasedAccessLogPublisherCfgDefn.LogFormat	getLogFormat()	Gets the "log-format" property.
String	getLogRecordTimeFormat()	Gets the "log-record-time-format" property.
int	getQueueSize()	Gets the "queue-size" property.
SortedSet<String>	getRetentionPolicy()	Gets the "retention-policy" property.
SortedSet<String>	getRotationPolicy()	Gets the "rotation-policy" property.
long	getTimeInterval()	Gets the "time-interval" property.
boolean	isAppend()	Gets the "append" property.
boolean	isAsynchronous()	Gets the "asynchronous" property.
boolean	isAutoFlush()	Gets the "auto-flush" property.
boolean	isLogControlOids()	Gets the "log-control-oids" property.
void	setAppend(Boolean value)	Sets the "append" property.
void	setAsynchronous(boolean value)	Sets the "asynchronous" property.
void	setAutoFlush(Boolean value)	Sets the "auto-flush" property.
void	setBufferSize(Long value)	Sets the "buffer-size" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setLogControlOids(Boolean value)	Sets the "log-control-oids" property.
void	setLogFile(String value)	Sets the "log-file" property.
void	setLogFilePermissions(String value)	Sets the "log-file-permissions" property.
void	setLogFormat(FileBasedAccessLogPublisherCfgDefn.LogFormat value)	Sets the "log-format" property.
void	setLogRecordTimeFormat(String value)	Sets the "log-record-time-format" property.
void	setQueueSize(Integer value)	Sets the "queue-size" property.
void	setRetentionPolicy(Collection<String> values)	Sets the "retention-policy" property.
void	setRotationPolicy(Collection<String> values)	Sets the "rotation-policy" property.
void	setTimeInterval(Long value)	Sets the "time-interval" 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 FileBasedAccessLogPublisherCfgClient,? extends FileBasedAccessLogPublisherCfg> definition()

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

isAppend

boolean isAppend()

Gets the "append" property.

Specifies whether to append to existing log files.

Returns:

Returns the value of the "append" property.

setAppend

void setAppend(Boolean value)
        throws PropertyException

Sets the "append" property.

Specifies whether to append to existing log files.

Parameters:

value - The value of the "append" property.

Throws:

PropertyException - If the new value is invalid.

isAsynchronous

boolean isAsynchronous()

Gets the "asynchronous" property.

Indicates whether the File Based Access Log Publisher will publish records asynchronously.

Returns:

Returns the value of the "asynchronous" property.

setAsynchronous

void setAsynchronous(boolean value)
              throws PropertyException

Sets the "asynchronous" property.

Indicates whether the File Based Access Log Publisher will publish records asynchronously.

Parameters:

value - The value of the "asynchronous" property.

Throws:

PropertyException - If the new value is invalid.

isAutoFlush

boolean isAutoFlush()

Gets the "auto-flush" property.

Specifies whether to flush the writer after every log record.

If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.

Returns:

Returns the value of the "auto-flush" property.

setAutoFlush

void setAutoFlush(Boolean value)
           throws PropertyException

Sets the "auto-flush" property.

Specifies whether to flush the writer after every log record.

If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.

Parameters:

value - The value of the "auto-flush" property.

Throws:

PropertyException - If the new value is invalid.

getBufferSize

long getBufferSize()

Gets the "buffer-size" property.

Specifies the log file buffer size.

Returns:

Returns the value of the "buffer-size" property.

setBufferSize

void setBufferSize(Long value)
            throws PropertyException

Sets the "buffer-size" property.

Specifies the log file buffer size.

Parameters:

value - The value of the "buffer-size" 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 File Based 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 File Based 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.

getLogFile

String getLogFile()

Gets the "log-file" property.

The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.

Returns:

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

setLogFile

void setLogFile(String value)
         throws PropertyException

Sets the "log-file" property.

The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getLogFilePermissions

String getLogFilePermissions()

Gets the "log-file-permissions" property.

The UNIX permissions of the log files created by this File Based Access Log Publisher.

Returns:

Returns the value of the "log-file-permissions" property.

setLogFilePermissions

void setLogFilePermissions(String value)
                    throws PropertyException

Sets the "log-file-permissions" property.

The UNIX permissions of the log files created by this File Based Access Log Publisher.

Parameters:

value - The value of the "log-file-permissions" property.

Throws:

PropertyException - If the new value is invalid.

getLogFormat

FileBasedAccessLogPublisherCfgDefn.LogFormat getLogFormat()

Gets the "log-format" property.

Specifies how log records should be formatted and written to the access log.

Returns:

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

setLogFormat

void setLogFormat(FileBasedAccessLogPublisherCfgDefn.LogFormat value)
           throws PropertyException

Sets the "log-format" property.

Specifies how log records should be formatted and written to the access log.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getLogRecordTimeFormat

String getLogRecordTimeFormat()

Gets the "log-record-time-format" property.

Specifies the format string that is used to generate log record timestamps.

Returns:

Returns the value of the "log-record-time-format" property.

setLogRecordTimeFormat

void setLogRecordTimeFormat(String value)
                     throws PropertyException

Sets the "log-record-time-format" property.

Specifies the format string that is used to generate log record timestamps.

Parameters:

value - The value of the "log-record-time-format" property.

Throws:

PropertyException - If the new value is invalid.

getQueueSize

int getQueueSize()

Gets the "queue-size" property.

The maximum number of log records that can be stored in the asynchronous queue.

Returns:

Returns the value of the "queue-size" property.

setQueueSize

void setQueueSize(Integer value)
           throws PropertyException

Sets the "queue-size" property.

The maximum number of log records that can be stored in the asynchronous queue.

Parameters:

value - The value of the "queue-size" 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 File Based 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 File Based 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 File Based 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 File Based 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.

getTimeInterval

long getTimeInterval()

Gets the "time-interval" property.

Specifies the interval at which to check whether the log files need to be rotated.

Returns:

Returns the value of the "time-interval" property.

setTimeInterval

void setTimeInterval(Long value)
              throws PropertyException

Sets the "time-interval" property.

Specifies the interval at which to check whether the log files need to be rotated.

Parameters:

value - The value of the "time-interval" property.

Throws:

PropertyException - If the new value is invalid.