|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileBasedErrorLogPublisherCfgClient
A client-side interface for reading and modifying File Based Error Log Publisher settings.
File Based Error Log Publishers publish error messages to the file system.
Method Summary | |
---|---|
ManagedObjectDefinition<? extends FileBasedErrorLogPublisherCfgClient,? extends FileBasedErrorLogPublisherCfg> |
definition()
Get the configuration definition associated with this File Based Error Log Publisher. |
long |
getBufferSize()
Gets the "buffer-size" property. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.lang.String |
getLogFile()
Gets the "log-file" property. |
java.lang.String |
getLogFilePermissions()
Gets the "log-file-permissions" property. |
int |
getQueueSize()
Gets the "queue-size" property. |
java.util.SortedSet<java.lang.String> |
getRetentionPolicy()
Gets the "retention-policy" property. |
java.util.SortedSet<java.lang.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. |
void |
setAppend(java.lang.Boolean value)
Sets the "append" property. |
void |
setAsynchronous(boolean value)
Sets the "asynchronous" property. |
void |
setAutoFlush(java.lang.Boolean value)
Sets the "auto-flush" property. |
void |
setBufferSize(java.lang.Long value)
Sets the "buffer-size" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setLogFile(java.lang.String value)
Sets the "log-file" property. |
void |
setLogFilePermissions(java.lang.String value)
Sets the "log-file-permissions" property. |
void |
setQueueSize(java.lang.Integer value)
Sets the "queue-size" property. |
void |
setRetentionPolicy(java.util.Collection<java.lang.String> values)
Sets the "retention-policy" property. |
void |
setRotationPolicy(java.util.Collection<java.lang.String> values)
Sets the "rotation-policy" property. |
void |
setTimeInterval(java.lang.Long value)
Sets the "time-interval" property. |
Methods inherited from interface org.opends.server.admin.std.client.ErrorLogPublisherCfgClient |
---|
getDefaultSeverity, getOverrideSeverity, setDefaultSeverity, setOverrideSeverity |
Methods inherited from interface org.opends.server.admin.std.client.LogPublisherCfgClient |
---|
isEnabled, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends FileBasedErrorLogPublisherCfgClient,? extends FileBasedErrorLogPublisherCfg> definition()
definition
in interface ConfigurationClient
definition
in interface ErrorLogPublisherCfgClient
definition
in interface LogPublisherCfgClient
boolean isAppend()
Specifies whether to append to existing log files.
void setAppend(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies whether to append to existing log files.
value
- The value of the "append" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isAsynchronous()
Indicates whether the File Based Error Log Publisher will publish records asynchronously.
void setAsynchronous(boolean value) throws IllegalPropertyValueException
Indicates whether the File Based Error Log Publisher will publish records asynchronously.
value
- The value of the "asynchronous" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isAutoFlush()
Specifies whether to flush the writer after every log record.
If the asynchronous writes option is used, the writer will be flushed after all the log records in the queue are written.
void setAutoFlush(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies whether to flush the writer after every log record.
If the asynchronous writes option is used, the writer will be flushed after all the log records in the queue are written.
value
- The value of the "auto-flush" property.
IllegalPropertyValueException
- If the new value is invalid.long getBufferSize()
Specifies the log file buffer size.
void setBufferSize(java.lang.Long value) throws IllegalPropertyValueException
Specifies the log file buffer size.
value
- The value of the "buffer-size" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getJavaClass()
The fully-qualified name of the Java class that provides the File Based Error Log Publisher implementation.
getJavaClass
in interface ErrorLogPublisherCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
The fully-qualified name of the Java class that provides the File Based Error Log Publisher implementation.
setJavaClass
in interface ErrorLogPublisherCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getLogFile()
The file name to use for the log files generated by the File Based Error Log Publisher .
The path to the file is relative to the server root.
void setLogFile(java.lang.String value) throws IllegalPropertyValueException
The file name to use for the log files generated by the File Based Error Log Publisher .
The path to the file is relative to the server root.
value
- The value of the "log-file" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getLogFilePermissions()
The UNIX permissions of the log files created by this File Based Error Log Publisher .
void setLogFilePermissions(java.lang.String value) throws IllegalPropertyValueException
The UNIX permissions of the log files created by this File Based Error Log Publisher .
value
- The value of the "log-file-permissions" property.
IllegalPropertyValueException
- If the new value is invalid.int getQueueSize()
The maximum number of log records that can be stored in the asynchronous queue.
void setQueueSize(java.lang.Integer value) throws IllegalPropertyValueException
The maximum number of log records that can be stored in the asynchronous queue.
value
- The value of the "queue-size" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.String> getRetentionPolicy()
The retention policy to use for the File Based Error Log Publisher .
When multiple policies are used, log files will be cleaned when any of the policy's conditions are met.
void setRetentionPolicy(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
The retention policy to use for the File Based Error Log Publisher .
When multiple policies are used, log files will be cleaned when any of the policy's conditions are met.
values
- The values of the "retention-policy" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.util.SortedSet<java.lang.String> getRotationPolicy()
The rotation policy to use for the File Based Error Log Publisher .
When multiple policies are used, rotation will occur if any policy's conditions are met.
void setRotationPolicy(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
The rotation policy to use for the File Based Error Log Publisher .
When multiple policies are used, rotation will occur if any policy's conditions are met.
values
- The values of the "rotation-policy" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.long getTimeInterval()
Specifies the interval at which to check whether the log files need to be rotated.
void setTimeInterval(java.lang.Long value) throws IllegalPropertyValueException
Specifies the interval at which to check whether the log files need to be rotated.
value
- The value of the "time-interval" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |