Package org.forgerock.opendj.server.config.meta

Class FileBasedAccessLogPublisherCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<FileBasedAccessLogPublisherCfgClient,FileBasedAccessLogPublisherCfg>
org.forgerock.opendj.server.config.meta.FileBasedAccessLogPublisherCfgDefn
public final class FileBasedAccessLogPublisherCfgDefn extends ManagedObjectDefinition<FileBasedAccessLogPublisherCfgClient,FileBasedAccessLogPublisherCfg>
An interface for querying the File Based Access Log Publisher managed object definition meta information.

File Based Access Log Publishers publish access messages to the file system.

  • Method Details

    • getInstance

      public static FileBasedAccessLogPublisherCfgDefn getInstance()
      Get the File Based Access Log Publisher configuration definition singleton.
      Returns:
      Returns the File Based Access Log Publisher configuration definition singleton.

    • createClientConfiguration

      public FileBasedAccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends FileBasedAccessLogPublisherCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      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<FileBasedAccessLogPublisherCfgClient,FileBasedAccessLogPublisherCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public FileBasedAccessLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends FileBasedAccessLogPublisherCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<FileBasedAccessLogPublisherCfgClient,FileBasedAccessLogPublisherCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<FileBasedAccessLogPublisherCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<FileBasedAccessLogPublisherCfgClient,FileBasedAccessLogPublisherCfg>
      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 Access 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 is 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.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the File Based Access Log Publisher is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getFilteringPolicyPropertyDefinition

      public EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy> getFilteringPolicyPropertyDefinition()
      Get the "filtering-policy" property definition.

      Specifies how filtering criteria should be applied to log records.

      Returns:
      Returns the "filtering-policy" 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 Access Log Publisher implementation.

      Returns:
      Returns the "java-class" property definition.

    • getLogControlsPropertyDefinition

      public BooleanPropertyDefinition getLogControlsPropertyDefinition()
      Get the "log-controls" property definition.

      Specifies whether controls with criticality and values will be included in operation log records.

      Returns:
      Returns the "log-controls" 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 Access 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 Access Log Publisher.

      Returns:
      Returns the "log-file-permissions" property definition.

    • getLogFormatPropertyDefinition

      public EnumPropertyDefinition<FileBasedAccessLogPublisherCfgDefn.LogFormat> getLogFormatPropertyDefinition()
      Get the "log-format" property definition.

      Specifies how log records should be formatted and written to the access log.

      Returns:
      Returns the "log-format" property definition.

    • getLogRecordTimeFormatPropertyDefinition

      public StringPropertyDefinition getLogRecordTimeFormatPropertyDefinition()
      Get the "log-record-time-format" property definition.

      Specifies the format string that is used to generate log record timestamps.

      Returns:
      Returns the "log-record-time-format" 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 Access Log Publisher .

      When multiple policies are used, log files are 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 Access Log Publisher .

      When multiple policies are used, rotation will occur if any policy's conditions are met.

      Returns:
      Returns the "rotation-policy" property definition.

    • getSuppressInternalOperationsPropertyDefinition

      public BooleanPropertyDefinition getSuppressInternalOperationsPropertyDefinition()
      Get the "suppress-internal-operations" property definition.

      Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

      Returns:
      Returns the "suppress-internal-operations" property definition.

    • getSuppressSynchronizationOperationsPropertyDefinition

      public BooleanPropertyDefinition getSuppressSynchronizationOperationsPropertyDefinition()
      Get the "suppress-synchronization-operations" property definition.

      Indicates whether access messages that are generated by synchronization operations should be suppressed.

      Returns:
      Returns the "suppress-synchronization-operations" 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.

    • getAccessLogFilteringCriteriaRelationDefinition

      public InstantiableRelationDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg> getAccessLogFilteringCriteriaRelationDefinition()
      Get the "access-log-filtering-criteria" relation definition.
      Returns:
      Returns the "access-log-filtering-criteria" relation definition.