org.opends.server.admin.std.client
Interface SizeLimitLogRotationPolicyCfgClient

All Superinterfaces:
ConfigurationClient, LogRotationPolicyCfgClient

public interface SizeLimitLogRotationPolicyCfgClient
extends LogRotationPolicyCfgClient

A client-side interface for reading and modifying Size Limit Log Rotation Policy settings.

Rotation policy based on the size of the log file.


Method Summary
 ManagedObjectDefinition<? extends SizeLimitLogRotationPolicyCfgClient,? extends SizeLimitLogRotationPolicyCfg> definition()
          Get the configuration definition associated with this Size Limit Log Rotation Policy.
 java.lang.Long getFileSizeLimit()
          Gets the "file-size-limit" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void setFileSizeLimit(long value)
          Sets the "file-size-limit" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends SizeLimitLogRotationPolicyCfgClient,? extends SizeLimitLogRotationPolicyCfg> definition()
Get the configuration definition associated with this Size Limit Log Rotation Policy.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface LogRotationPolicyCfgClient
Returns:
Returns the configuration definition associated with this Size Limit Log Rotation Policy.

getFileSizeLimit

java.lang.Long getFileSizeLimit()
Gets the "file-size-limit" property.

Specifies the maximum size that a log file can reach before it is rotated.

Returns:
Returns the value of the "file-size-limit" property.

setFileSizeLimit

void setFileSizeLimit(long value)
                      throws IllegalPropertyValueException
Sets the "file-size-limit" property.

Specifies the maximum size that a log file can reach before it is rotated.

Parameters:
value - The value of the "file-size-limit" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Specified by:
getJavaClass in interface LogRotationPolicyCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface LogRotationPolicyCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.