public interface FileBasedErrorLogPublisherCfgClient extends ErrorLogPublisherCfgClient
File Based Error Log Publishers publish error messages to the file system.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends FileBasedErrorLogPublisherCfgClient,? extends FileBasedErrorLogPublisherCfg> |
definition()
Get the configuration definition associated with this File Based Error Log Publisher.
|
ValueOrExpression<Long> |
getBufferSize()
Gets the "buffer-size" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getLogFile()
Gets the "log-file" property.
|
ValueOrExpression<String> |
getLogFilePermissions()
Gets the "log-file-permissions" property.
|
ValueOrExpression<Integer> |
getQueueSize()
Gets the "queue-size" property.
|
SortedSet<ValueOrExpression<String>> |
getRetentionPolicy()
Gets the "retention-policy" property.
|
SortedSet<ValueOrExpression<String>> |
getRotationPolicy()
Gets the "rotation-policy" property.
|
ValueOrExpression<Long> |
getTimeInterval()
Gets the "time-interval" property.
|
ValueOrExpression<Boolean> |
isAppend()
Gets the "append" property.
|
ValueOrExpression<Boolean> |
isAsynchronous()
Gets the "asynchronous" property.
|
ValueOrExpression<Boolean> |
isAutoFlush()
Gets the "auto-flush" property.
|
void |
setAppend(ValueOrExpression<Boolean> value)
Sets the "append" property.
|
void |
setAsynchronous(ValueOrExpression<Boolean> value)
Sets the "asynchronous" property.
|
void |
setAutoFlush(ValueOrExpression<Boolean> value)
Sets the "auto-flush" property.
|
void |
setBufferSize(ValueOrExpression<Long> value)
Sets the "buffer-size" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setLogFile(ValueOrExpression<String> value)
Sets the "log-file" property.
|
void |
setLogFilePermissions(ValueOrExpression<String> value)
Sets the "log-file-permissions" property.
|
void |
setQueueSize(ValueOrExpression<Integer> value)
Sets the "queue-size" property.
|
void |
setRetentionPolicy(Collection<ValueOrExpression<String>> values)
Sets the "retention-policy" property.
|
void |
setRotationPolicy(Collection<ValueOrExpression<String>> values)
Sets the "rotation-policy" property.
|
void |
setTimeInterval(ValueOrExpression<Long> value)
Sets the "time-interval" property.
|
getDefaultSeverity, getOverrideSeverity, setDefaultSeverity, setOverrideSeverity
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends FileBasedErrorLogPublisherCfgClient,? extends FileBasedErrorLogPublisherCfg> definition()
definition
in interface ConfigurationClient
definition
in interface ErrorLogPublisherCfgClient
definition
in interface LogPublisherCfgClient
ValueOrExpression<Boolean> isAppend()
Specifies whether to append to existing log files.
void setAppend(ValueOrExpression<Boolean> value) throws PropertyException
Specifies whether to append to existing log files.
value
- The value of the "append" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isAsynchronous()
Indicates whether the File Based Error Log Publisher will publish records asynchronously.
void setAsynchronous(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the File Based Error Log Publisher will publish records asynchronously.
value
- The value of the "asynchronous" property.PropertyException
- If the new value is invalid.ValueOrExpression<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(ValueOrExpression<Boolean> value) throws PropertyException
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.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getBufferSize()
Specifies the log file buffer size.
void setBufferSize(ValueOrExpression<Long> value) throws PropertyException
Specifies the log file buffer size.
value
- The value of the "buffer-size" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
The fully-qualified name of the Java class that provides the File Based Error Log Publisher implementation.
getJavaClass
in interface ErrorLogPublisherCfgClient
getJavaClass
in interface LogPublisherCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
The fully-qualified name of the Java class that provides the File Based Error Log Publisher implementation.
setJavaClass
in interface ErrorLogPublisherCfgClient
setJavaClass
in interface LogPublisherCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<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(ValueOrExpression<String> value) throws PropertyException
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.PropertyException
- If the new value is invalid.ValueOrExpression<String> getLogFilePermissions()
The UNIX permissions of the log files created by this File Based Error Log Publisher .
void setLogFilePermissions(ValueOrExpression<String> value) throws PropertyException
The UNIX permissions of the log files created by this File Based Error Log Publisher .
value
- The value of the "log-file-permissions" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getQueueSize()
The maximum number of log records that can be stored in the asynchronous queue.
void setQueueSize(ValueOrExpression<Integer> value) throws PropertyException
The maximum number of log records that can be stored in the asynchronous queue.
value
- The value of the "queue-size" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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(Collection<ValueOrExpression<String>> values) throws PropertyException
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.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<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(Collection<ValueOrExpression<String>> values) throws PropertyException
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.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Long> getTimeInterval()
Specifies the interval at which to check whether the log files need to be rotated.
void setTimeInterval(ValueOrExpression<Long> value) throws PropertyException
Specifies the interval at which to check whether the log files need to be rotated.
value
- The value of the "time-interval" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.