Package org.forgerock.opendj.server.config.client

Interface FileBasedHttpAccessLogPublisherCfgClient

All Superinterfaces:
ConfigurationClient, HttpAccessLogPublisherCfgClient, LogPublisherCfgClient
public interface FileBasedHttpAccessLogPublisherCfgClient extends HttpAccessLogPublisherCfgClient
A client-side interface for reading and modifying File Based HTTP Access Log Publisher settings.

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

  • Method Details

    • definition

      ManagedObjectDefinition<? extends FileBasedHttpAccessLogPublisherCfgClient,? extends FileBasedHttpAccessLogPublisherCfg> definition()
      Get the configuration definition associated with this File Based HTTP Access Log Publisher.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface HttpAccessLogPublisherCfgClient
      Specified by:
      definition in interface LogPublisherCfgClient
      Returns:
      Returns the configuration definition associated with this File Based HTTP Access Log Publisher.

    • isAppend

      ValueOrExpression<Boolean> isAppend()
      Gets the "append" property.

      Specifies whether to append to existing log files.

      Default value: true

      Returns:
      Returns the value of the "append" property.

    • setAppend

      void setAppend(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "append" property.

      Specifies whether to append to existing log files.

      Parameters:
      value - The value of the "append" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isAsynchronous

      @MandatoryProperty ValueOrExpression<Boolean> isAsynchronous()
      Gets the "asynchronous" property.

      Indicates whether the File Based HTTP Access Log Publisher will publish records asynchronously.

      Default value: true

      Returns:
      Returns the value of the "asynchronous" property.

    • setAsynchronous

      @MandatoryProperty void setAsynchronous(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "asynchronous" property.

      Indicates whether the File Based HTTP Access Log Publisher will publish records asynchronously.

      Parameters:
      value - The value of the "asynchronous" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isAutoFlush

      ValueOrExpression<Boolean> isAutoFlush()
      Gets the "auto-flush" property.

      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.

      Default value: true

      Returns:
      Returns the value of the "auto-flush" property.

    • setAutoFlush

      void setAutoFlush(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "auto-flush" property.

      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.

      Parameters:
      value - The value of the "auto-flush" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getBufferSize

      ValueOrExpression<Long> getBufferSize()
      Gets the "buffer-size" property.

      Specifies the log file buffer size.

      Default value: 64kb

      Returns:
      Returns the value of the "buffer-size" property.

    • setBufferSize

      void setBufferSize(ValueOrExpression<Long> value) throws PropertyException
      Sets the "buffer-size" property.

      Specifies the log file buffer size.

      Parameters:
      value - The value of the "buffer-size" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      The fully-qualified name of the Java class that provides the File Based HTTP Access Log Publisher implementation.

      Default value: org.opends.server.loggers.TextHTTPAccessLogPublisher

      Specified by:
      getJavaClass in interface HttpAccessLogPublisherCfgClient
      Specified by:
      getJavaClass in interface LogPublisherCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      The fully-qualified name of the Java class that provides the File Based HTTP Access Log Publisher implementation.

      Specified by:
      setJavaClass in interface HttpAccessLogPublisherCfgClient
      Specified by:
      setJavaClass in interface LogPublisherCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getLogFile

      @MandatoryProperty ValueOrExpression<String> getLogFile()
      Gets the "log-file" property.

      The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the server root.

      Returns:
      Returns the value of the "log-file" property.

    • setLogFile

      @MandatoryProperty void setLogFile(ValueOrExpression<String> value) throws PropertyException
      Sets the "log-file" property.

      The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the server root.

      Parameters:
      value - The value of the "log-file" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getLogFilePermissions

      @MandatoryProperty ValueOrExpression<String> getLogFilePermissions()
      Gets the "log-file-permissions" property.

      The UNIX permissions of the log files created by this File Based HTTP Access Log Publisher.

      Default value: 640

      Returns:
      Returns the value of the "log-file-permissions" property.

    • setLogFilePermissions

      @MandatoryProperty void setLogFilePermissions(ValueOrExpression<String> value) throws PropertyException
      Sets the "log-file-permissions" property.

      The UNIX permissions of the log files created by this File Based HTTP Access Log Publisher.

      Parameters:
      value - The value of the "log-file-permissions" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getLogFormat

      ValueOrExpression<String> getLogFormat()
      Gets the "log-format" property.

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

      Default value: cs-host c-ip cs-username x-datetime cs-method cs-uri-stem cs-uri-query cs-version sc-status cs(User-Agent) x-connection-id x-etime x-transaction-id

      Returns:
      Returns the value of the "log-format" property.

    • setLogFormat

      void setLogFormat(ValueOrExpression<String> value) throws PropertyException
      Sets the "log-format" property.

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

      Parameters:
      value - The value of the "log-format" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getLogRecordTimeFormat

      ValueOrExpression<String> getLogRecordTimeFormat()
      Gets the "log-record-time-format" property.

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

      Default value: dd/MMM/yyyy:HH:mm:ss Z

      Returns:
      Returns the value of the "log-record-time-format" property.

    • setLogRecordTimeFormat

      void setLogRecordTimeFormat(ValueOrExpression<String> value) throws PropertyException
      Sets the "log-record-time-format" property.

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

      Parameters:
      value - The value of the "log-record-time-format" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getQueueSize

      ValueOrExpression<Integer> getQueueSize()
      Gets the "queue-size" property.

      The maximum number of log records that can be stored in the asynchronous queue.

      Default value: 5000

      Returns:
      Returns the value of the "queue-size" property.

    • setQueueSize

      void setQueueSize(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "queue-size" property.

      The maximum number of log records that can be stored in the asynchronous queue.

      Parameters:
      value - The value of the "queue-size" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getRetentionPolicy

      SortedSet<ValueOrExpression<String>> getRetentionPolicy()
      Gets the "retention-policy" property.

      The retention policy to use for the File Based HTTP Access Log Publisher .

      When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

      Returns:
      Returns the values of the "retention-policy" property.

    • setRetentionPolicy

      void setRetentionPolicy(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "retention-policy" property.

      The retention policy to use for the File Based HTTP Access Log Publisher .

      When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

      Parameters:
      values - The values of the "retention-policy" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getRotationPolicy

      SortedSet<ValueOrExpression<String>> getRotationPolicy()
      Gets the "rotation-policy" property.

      The rotation policy to use for the File Based HTTP Access Log Publisher .

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

      Returns:
      Returns the values of the "rotation-policy" property.

    • setRotationPolicy

      void setRotationPolicy(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "rotation-policy" property.

      The rotation policy to use for the File Based HTTP Access Log Publisher .

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

      Parameters:
      values - The values of the "rotation-policy" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getTimeInterval

      ValueOrExpression<Long> getTimeInterval()
      Gets the "time-interval" property.

      Specifies the interval at which to check whether the log files need to be rotated.

      Default value: 5s

      Returns:
      Returns the value of the "time-interval" property.

    • setTimeInterval

      void setTimeInterval(ValueOrExpression<Long> value) throws PropertyException
      Sets the "time-interval" property.

      Specifies the interval at which to check whether the log files need to be rotated.

      Parameters:
      value - The value of the "time-interval" property.
      Throws:
      PropertyException - If the new value is invalid.