FileBasedErrorLogPublisherCfgDefn (OpenDJ 3.0.0 Documentation)

java.lang.Object
- org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
- - org.opends.server.admin.ManagedObjectDefinition<FileBasedErrorLogPublisherCfgClient,FileBasedErrorLogPublisherCfg>
  - - org.opends.server.admin.std.meta.FileBasedErrorLogPublisherCfgDefn

```
public final class FileBasedErrorLogPublisherCfgDefn
extends ManagedObjectDefinition<FileBasedErrorLogPublisherCfgClient,FileBasedErrorLogPublisherCfg>
```
An interface for querying the File Based Error Log Publisher managed object definition meta information.
File Based Error Log Publishers publish error messages to the file system.

Method Summary

Methods
Modifier and Type	Method and Description
`FileBasedErrorLogPublisherCfgClient`	`createClientConfiguration(ManagedObject<? extends FileBasedErrorLogPublisherCfgClient> impl)` Creates a client configuration view of the provided managed object.
`FileBasedErrorLogPublisherCfg`	`createServerConfiguration(ServerManagedObject<? extends FileBasedErrorLogPublisherCfg> impl)` Creates a server configuration view of the provided server managed object.
`BooleanPropertyDefinition`	`getAppendPropertyDefinition()` Get the "append" property definition.
`BooleanPropertyDefinition`	`getAsynchronousPropertyDefinition()` Get the "asynchronous" property definition.
`BooleanPropertyDefinition`	`getAutoFlushPropertyDefinition()` Get the "auto-flush" property definition.
`SizePropertyDefinition`	`getBufferSizePropertyDefinition()` Get the "buffer-size" property definition.
`EnumPropertyDefinition<ErrorLogPublisherCfgDefn.DefaultSeverity>`	`getDefaultSeverityPropertyDefinition()` Get the "default-severity" property definition.
`BooleanPropertyDefinition`	`getEnabledPropertyDefinition()` Get the "enabled" property definition.
`static FileBasedErrorLogPublisherCfgDefn`	`getInstance()` Get the File Based Error Log Publisher configuration definition singleton.
`ClassPropertyDefinition`	`getJavaClassPropertyDefinition()` Get the "java-class" property definition.
`StringPropertyDefinition`	`getLogFilePermissionsPropertyDefinition()` Get the "log-file-permissions" property definition.
`StringPropertyDefinition`	`getLogFilePropertyDefinition()` Get the "log-file" property definition.
`StringPropertyDefinition`	`getOverrideSeverityPropertyDefinition()` Get the "override-severity" property definition.
`IntegerPropertyDefinition`	`getQueueSizePropertyDefinition()` Get the "queue-size" property definition.
`AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>`	`getRetentionPolicyPropertyDefinition()` Get the "retention-policy" property definition.
`AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg>`	`getRotationPolicyPropertyDefinition()` Get the "rotation-policy" property definition.
`Class<FileBasedErrorLogPublisherCfg>`	`getServerConfigurationClass()` Gets the server configuration class instance associated with this managed object definition.
`DurationPropertyDefinition`	`getTimeIntervalPropertyDefinition()` Get the "time-interval" property definition.

Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getInstance
```
public static FileBasedErrorLogPublisherCfgDefn getInstance()
```
    Get the File Based Error Log Publisher configuration definition singleton.
    
    Returns:
    Returns the File Based Error Log Publisher configuration definition singleton.
  - createClientConfiguration
```
public FileBasedErrorLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends FileBasedErrorLogPublisherCfgClient> impl)
```
    Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
    
    Specified by:
    
    createClientConfiguration in class ManagedObjectDefinition<FileBasedErrorLogPublisherCfgClient,FileBasedErrorLogPublisherCfg>
    
    Parameters:
    impl - The managed object.
    
    Returns:
    Returns a client configuration view of the provided managed object.
  - createServerConfiguration
```
public FileBasedErrorLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends FileBasedErrorLogPublisherCfg> impl)
```
    Creates a server configuration view of the provided server managed object.
    
    Specified by:
    
    createServerConfiguration in class ManagedObjectDefinition<FileBasedErrorLogPublisherCfgClient,FileBasedErrorLogPublisherCfg>
    
    Parameters:
    impl - The server managed object.
    
    Returns:
    Returns a server configuration view of the provided server managed object.
  - getServerConfigurationClass
```
public Class<FileBasedErrorLogPublisherCfg> getServerConfigurationClass()
```
    Gets the server configuration class instance associated with this managed object definition.
    
    Specified by:
    
    getServerConfigurationClass in class ManagedObjectDefinition<FileBasedErrorLogPublisherCfgClient,FileBasedErrorLogPublisherCfg>
    
    Returns:
    Returns the server configuration class instance associated with this managed object definition.
  - getAppendPropertyDefinition
```
public BooleanPropertyDefinition getAppendPropertyDefinition()
```
    Get the "append" property definition.
    Specifies whether to append to existing log files.
    
    Returns:
    Returns the "append" property definition.
  - getAsynchronousPropertyDefinition
```
public BooleanPropertyDefinition getAsynchronousPropertyDefinition()
```
    Get the "asynchronous" property definition.
    Indicates whether the File Based Error Log Publisher will publish records asynchronously.
    
    Returns:
    Returns the "asynchronous" property definition.
  - getAutoFlushPropertyDefinition
```
public BooleanPropertyDefinition getAutoFlushPropertyDefinition()
```
    Get the "auto-flush" property definition.
    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.
    
    Returns:
    Returns the "auto-flush" property definition.
  - getBufferSizePropertyDefinition
```
public SizePropertyDefinition getBufferSizePropertyDefinition()
```
    Get the "buffer-size" property definition.
    Specifies the log file buffer size.
    
    Returns:
    Returns the "buffer-size" property definition.
  - getDefaultSeverityPropertyDefinition
```
public EnumPropertyDefinition<ErrorLogPublisherCfgDefn.DefaultSeverity> getDefaultSeverityPropertyDefinition()
```
    Get the "default-severity" property definition.
    Specifies the default severity levels for the logger.
    
    Returns:
    Returns the "default-severity" property definition.
  - getEnabledPropertyDefinition
```
public BooleanPropertyDefinition getEnabledPropertyDefinition()
```
    Get the "enabled" property definition.
    Indicates whether the File Based Error Log Publisher is enabled for use.
    
    Returns:
    Returns the "enabled" property definition.
  - getJavaClassPropertyDefinition
```
public ClassPropertyDefinition getJavaClassPropertyDefinition()
```
    Get the "java-class" property definition.
    The fully-qualified name of the Java class that provides the File Based Error Log Publisher implementation.
    
    Returns:
    Returns the "java-class" property definition.
  - getLogFilePropertyDefinition
```
public StringPropertyDefinition getLogFilePropertyDefinition()
```
    Get the "log-file" property definition.
    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.
    
    Returns:
    Returns the "log-file" property definition.
  - getLogFilePermissionsPropertyDefinition
```
public StringPropertyDefinition getLogFilePermissionsPropertyDefinition()
```
    Get the "log-file-permissions" property definition.
    The UNIX permissions of the log files created by this File Based Error Log Publisher .
    
    Returns:
    Returns the "log-file-permissions" property definition.
  - getOverrideSeverityPropertyDefinition
```
public StringPropertyDefinition getOverrideSeverityPropertyDefinition()
```
    Get the "override-severity" property definition.
    Specifies the override severity levels for the logger based on the category of the messages.
    Each override severity level should include the category and the severity levels to log for that category, for example, core=error,info,warning. Valid categories are: core, extensions, protocol, config, log, util, schema, plugin, jeb, backend, tools, task, access-control, admin, sync, version, quicksetup, admin-tool, dsconfig, user-defined. Valid severities are: all, error, info, warning, notice, debug.
    
    Returns:
    Returns the "override-severity" property definition.
  - getQueueSizePropertyDefinition
```
public IntegerPropertyDefinition getQueueSizePropertyDefinition()
```
    Get the "queue-size" property definition.
    The maximum number of log records that can be stored in the asynchronous queue.
    
    Returns:
    Returns the "queue-size" property definition.
  - getRetentionPolicyPropertyDefinition
```
public AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg> getRetentionPolicyPropertyDefinition()
```
    Get the "retention-policy" property definition.
    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.
    
    Returns:
    Returns the "retention-policy" property definition.
  - getRotationPolicyPropertyDefinition
```
public AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg> getRotationPolicyPropertyDefinition()
```
    Get the "rotation-policy" property definition.
    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.
    
    Returns:
    Returns the "rotation-policy" property definition.
  - getTimeIntervalPropertyDefinition
```
public DurationPropertyDefinition getTimeIntervalPropertyDefinition()
```
    Get the "time-interval" property definition.
    Specifies the interval at which to check whether the log files need to be rotated.
    
    Returns:
    Returns the "time-interval" property definition.

Class FileBasedErrorLogPublisherCfgDefn

Method Summary

Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition

Methods inherited from class java.lang.Object

Method Detail

getInstance

createClientConfiguration

createServerConfiguration

getServerConfigurationClass

getAppendPropertyDefinition

getAsynchronousPropertyDefinition

getAutoFlushPropertyDefinition

getBufferSizePropertyDefinition

getDefaultSeverityPropertyDefinition

getEnabledPropertyDefinition

getJavaClassPropertyDefinition

getLogFilePropertyDefinition

getLogFilePermissionsPropertyDefinition

getOverrideSeverityPropertyDefinition

getQueueSizePropertyDefinition

getRetentionPolicyPropertyDefinition

getRotationPolicyPropertyDefinition

getTimeIntervalPropertyDefinition