Package com.sun.enterprise.config.serverbeans

Interface AccessLog

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
public interface AccessLog extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
Access log configuration.

  • Method Details

    • getFormat

      String getFormat()
      Gets the value of the format attribute, which specifies the format of the access log.
      Returns:
      possible object is String

    • setFormat

      void setFormat(String format) throws PropertyVetoException
      Sets the value of the format attribute.
      Parameters:
      format - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getRotationPolicy

      String getRotationPolicy()
      Gets the value of the rotation-policy attribute.
      Returns:
      possible object is String

    • setRotationPolicy

      void setRotationPolicy(String rotationPolicy) throws PropertyVetoException
      Sets the value of the rotation-policy attribute.
      Parameters:
      rotationPolicy - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getRotationIntervalInMinutes

      @Min(1L) @Max(2147483647L) @Min(1L) @Max(2147483647L) String getRotationIntervalInMinutes()
      Gets the value of the rotation-interval-in-minutes attribute.

      The time interval in minutes between two successive rotations of the access logs.

      Returns:
      possible object is String

    • setRotationIntervalInMinutes

      void setRotationIntervalInMinutes(String rotationInterval) throws PropertyVetoException
      Sets the value of the rotation-interval-in-minutes attribute.
      Parameters:
      rotationInterval - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getRotationSuffix

      String getRotationSuffix()
      Gets the value of the rotation-suffix attribute.

      The suffix to be added to the access-log name after rotation. Acceptable values include those supported by SimpleDateFormat and "%YYYY;%MM;%DD;-%hh;h%mm;m%ss;s".

      Returns:
      possible object is String

    • setRotationSuffix

      void setRotationSuffix(String rotationSuffix) throws PropertyVetoException
      Sets the value of the rotation-suffix attribute.
      Parameters:
      rotationSuffix - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getRotationEnabled

      String getRotationEnabled()
      Gets the value of the rotation-enabled attribute.

      The flag for enabling the access-log rotation.

      Returns:
      possible object is String

    • setRotationEnabled

      void setRotationEnabled(String rotationEnabled) throws PropertyVetoException
      Sets the value of the rotation-enabled attribute.
      Parameters:
      rotationEnabled - allowed object is String
      Throws:
      PropertyVetoException - if a listener vetoes the change

    • getBufferSizeBytes

      String getBufferSizeBytes()
      Size in bytes of the buffer where access log calls are stored. If the value is less than 5120, a warning message is issued, and the value is set to 5120
      Returns:
      the buffer size

    • setBufferSizeBytes

      void setBufferSizeBytes(String bufferSize)

    • getWriteIntervalSeconds

      String getWriteIntervalSeconds()
      Number of seconds before the log is written to the disk. The access log is written when the buffer is full or when the interval expires. If the value is 0, the buffer is always written even if it is not full. This means that each time the server is accessed, the log message is stored directly to the file.
      Returns:
      the write interval in seconds

    • setWriteIntervalSeconds

      void setWriteIntervalSeconds(String writeInterval)

    • getMaxHistoryFiles

      @NotNull @NotNull String getMaxHistoryFiles()
      Gets the maximum number of rotated access log files that are to be kept.

      A negative value must be interpreted as no limit.

      Returns:
      the max number of log files

    • setMaxHistoryFiles

      void setMaxHistoryFiles(String maxHistoryFiles) throws PropertyVetoException
      Sets the maximum number of rotated access log files that are to be kept.
      Parameters:
      maxHistoryFiles - the maximum number of log files
      Throws:
      PropertyVetoException - if a listener vetoes the change