Interface SizeLimitLogRetentionPolicyCfgClient
-
- All Superinterfaces:
ConfigurationClient
,LogRetentionPolicyCfgClient
public interface SizeLimitLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient
A client-side interface for reading and modifying Size Limit Log Retention Policy settings.Retention policy based on the amount of space taken by all the log files on disk.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends SizeLimitLogRetentionPolicyCfgClient,? extends SizeLimitLogRetentionPolicyCfg>
definition()
Get the configuration definition associated with this Size Limit Log Retention Policy.ValueOrExpression<Long>
getDiskSpaceUsed()
Gets the "disk-space-used" property.ValueOrExpression<String>
getJavaClass()
Gets the "java-class" property.void
setDiskSpaceUsed(ValueOrExpression<Long> value)
Sets the "disk-space-used" property.void
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends SizeLimitLogRetentionPolicyCfgClient,? extends SizeLimitLogRetentionPolicyCfg> definition()
Get the configuration definition associated with this Size Limit Log Retention Policy.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfaceLogRetentionPolicyCfgClient
- Returns:
- Returns the configuration definition associated with this Size Limit Log Retention Policy.
-
getDiskSpaceUsed
@MandatoryProperty ValueOrExpression<Long> getDiskSpaceUsed()
Gets the "disk-space-used" property.Specifies the maximum total disk space used by the log files.
- Returns:
- Returns the value of the "disk-space-used" property.
-
setDiskSpaceUsed
@MandatoryProperty void setDiskSpaceUsed(ValueOrExpression<Long> value) throws PropertyException
Sets the "disk-space-used" property.Specifies the maximum total disk space used by the log files.
- Parameters:
value
- The value of the "disk-space-used" property.- Throws:
PropertyException
- If the new value is invalid.
-
getJavaClass
@MandatoryProperty ValueOrExpression<String> getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Size Limit Log Retention Policy implementation.
Default value:
org.opends.server.loggers.SizeBasedRetentionPolicy
- Specified by:
getJavaClass
in interfaceLogRetentionPolicyCfgClient
- 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 Size Limit Log Retention Policy implementation.
- Specified by:
setJavaClass
in interfaceLogRetentionPolicyCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
-