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

Interface FixedTimeLogRotationPolicyCfgClient

All Superinterfaces:

ConfigurationClient, LogRotationPolicyCfgClient

public interface FixedTimeLogRotationPolicyCfgClient
extends LogRotationPolicyCfgClient

A client-side interface for reading and modifying Fixed Time Log Rotation Policy settings.

Rotation policy based on a fixed time of day.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FixedTimeLogRotationPolicyCfgClient,? extends FixedTimeLogRotationPolicyCfg>	definition()	Get the configuration definition associated with this Fixed Time Log Rotation Policy.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<String>>	getTimeOfDay()	Gets the "time-of-day" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setTimeOfDay(Collection<ValueOrExpression<String>> values)	Sets the "time-of-day" property.

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends FixedTimeLogRotationPolicyCfgClient,? extends FixedTimeLogRotationPolicyCfg> definition()

Get the configuration definition associated with this Fixed Time Log Rotation Policy.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogRotationPolicyCfgClient

Returns:

Returns the configuration definition associated with this Fixed Time Log Rotation Policy.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Fixed Time Log Rotation Policy implementation.

Default value: org.opends.server.loggers.FixedTimeRotationPolicy

Specified by:

getJavaClass in interface LogRotationPolicyCfgClient

Returns:

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

setJavaClass

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

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Fixed Time Log Rotation Policy implementation.

Specified by:

setJavaClass in interface LogRotationPolicyCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getTimeOfDay

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getTimeOfDay()

Gets the "time-of-day" property.

Specifies the time of day at which log rotation should occur.

Returns:

Returns the values of the "time-of-day" property.

setTimeOfDay

@MandatoryProperty
void setTimeOfDay(Collection<ValueOrExpression<String>> values)
           throws PropertyException

Sets the "time-of-day" property.

Specifies the time of day at which log rotation should occur.

Parameters:

values - The values of the "time-of-day" property.

Throws:

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