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

Class CsvFileAccessLogPublisherCfgDefn

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

CSV File Access Log Publishers publish access messages to CSV files.

  • Method Details

    • getInstance

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

    • createClientConfiguration

      public CsvFileAccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends CsvFileAccessLogPublisherCfgClient> 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<CsvFileAccessLogPublisherCfgClient,CsvFileAccessLogPublisherCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

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

    • getServerConfigurationClass

      public Class<CsvFileAccessLogPublisherCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<CsvFileAccessLogPublisherCfgClient,CsvFileAccessLogPublisherCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getAsynchronousPropertyDefinition

      public BooleanPropertyDefinition getAsynchronousPropertyDefinition()
      Get the "asynchronous" property definition.

      Indicates whether the CSV File 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.

    • getCsvDelimiterCharPropertyDefinition

      public StringPropertyDefinition getCsvDelimiterCharPropertyDefinition()
      Get the "csv-delimiter-char" property definition.

      The delimiter character to use when writing in CSV format.

      Returns:
      Returns the "csv-delimiter-char" property definition.

    • getCsvEolSymbolsPropertyDefinition

      public StringPropertyDefinition getCsvEolSymbolsPropertyDefinition()
      Get the "csv-eol-symbols" property definition.

      The string that marks the end of a line.

      Returns:
      Returns the "csv-eol-symbols" property definition.

    • getCsvQuoteCharPropertyDefinition

      public StringPropertyDefinition getCsvQuoteCharPropertyDefinition()
      Get the "csv-quote-char" property definition.

      The character to append and prepend to a CSV field when writing in CSV format.

      Returns:
      Returns the "csv-quote-char" property definition.

    • getEnabledPropertyDefinition

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

      Indicates whether the CSV File 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 CSV File Access Log Publisher implementation.

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

    • getKeyStoreFilePropertyDefinition

      public StringPropertyDefinition getKeyStoreFilePropertyDefinition()
      Get the "key-store-file" property definition.

      Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

      Changes to this property will take effect the next time that the key store is accessed.

      Returns:
      Returns the "key-store-file" property definition.

    • getKeyStorePinPropertyDefinition

      public StringPropertyDefinition getKeyStorePinPropertyDefinition()
      Get the "key-store-pin" property definition.

      Specifies the clear-text PIN needed to access the CSV File Access Log Publisher .

      Returns:
      Returns the "key-store-pin" 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.

    • getLogDirectoryPropertyDefinition

      public StringPropertyDefinition getLogDirectoryPropertyDefinition()
      Get the "log-directory" property definition.

      The directory to use for the log files generated by the CSV File Access Log Publisher. The path to the directory is relative to the server root.

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

    • getLogFieldBlacklistPropertyDefinition

      public StringPropertyDefinition getLogFieldBlacklistPropertyDefinition()
      Get the "log-field-blacklist" property definition.

      List of fields that the server omits from access log messages.

      Valid values for this property are JSON paths for fields present in the log file.

      Returns:
      Returns the "log-field-blacklist" property definition.

    • getLogFileNamePrefixPropertyDefinition

      public StringPropertyDefinition getLogFileNamePrefixPropertyDefinition()
      Get the "log-file-name-prefix" property definition.

      File name prefix (without extension) for CSV and JSON file based access log publishers.

      Returns:
      Returns the "log-file-name-prefix" property definition.

    • getRetentionPolicyPropertyDefinition

      public AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg> getRetentionPolicyPropertyDefinition()
      Get the "retention-policy" property definition.

      The retention policy to use for the CSV File 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 CSV File 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.

    • getSignatureTimeIntervalPropertyDefinition

      public DurationPropertyDefinition getSignatureTimeIntervalPropertyDefinition()
      Get the "signature-time-interval" property definition.

      Specifies the interval at which to sign the log file when the tamper-evident option is enabled.

      Returns:
      Returns the "signature-time-interval" 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.

    • getTamperEvidentPropertyDefinition

      public BooleanPropertyDefinition getTamperEvidentPropertyDefinition()
      Get the "tamper-evident" property definition.

      Specifies whether the log should be signed in order to detect tampering.

      Every log record will be signed, making it possible to verify that the log has not been tampered with. This feature has a significant impact on performance of the server.

      Returns:
      Returns the "tamper-evident" 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.