org.opends.server.admin.std.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

Methods

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

Methods inherited from interface org.opends.server.admin.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

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.

Specified by:

getJavaClass in interface LogRotationPolicyCfgClient

Returns:

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

setJavaClass

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

SortedSet<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

void setTimeOfDay(Collection<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.