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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

    org.jvnet.hk2.config.ConfigBeanProxy.Duck

    Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

    org.jvnet.hk2.config.types.PropertyBag.Duck

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBufferSizeBytes()
    Size in bytes of the buffer where access log calls are stored.
    String
    getFormat()
    Gets the value of the format attribute, which specifies the format of the access log.
    @NotNull String
    getMaxHistoryFiles()
    Gets the maximum number of rotated access log files that are to be kept.
    String
    getRotationEnabled()
    Gets the value of the rotation-enabled attribute.
    @Min(1L) @Max(2147483647L) String
    getRotationIntervalInMinutes()
    Gets the value of the rotation-interval-in-minutes attribute.
    String
    getRotationPolicy()
    Gets the value of the rotation-policy attribute.
    String
    getRotationSuffix()
    Gets the value of the rotation-suffix attribute.
    String
    getWriteIntervalSeconds()
    Number of seconds before the log is written to the disk.
    void
    setBufferSizeBytes(String value)
     
    void
    setFormat(String value)
    Sets the value of the format attribute.
    void
    setMaxHistoryFiles(String value)
    Sets the maximum number of rotated access log files that are to be kept.
    void
    setRotationEnabled(String value)
    Sets the value of the rotation-enabled attribute.
    void
    setRotationIntervalInMinutes(String value)
    Sets the value of the rotation-interval-in-minutes attribute.
    void
    setRotationPolicy(String value)
    Sets the value of the rotation-policy attribute.
    void
    setRotationSuffix(String value)
    Sets the value of the rotation-suffix attribute.
    void
    setWriteIntervalSeconds(String value)
     

    Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

    createChild, deepCopy, getParent, getParent

    Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

    addProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

  • 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 value) throws PropertyVetoException
      Sets the value of the format attribute.
      Parameters:
      value - 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 value) throws PropertyVetoException
      Sets the value of the rotation-policy attribute.
      Parameters:
      value - 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 value) throws PropertyVetoException
      Sets the value of the rotation-interval-in-minutes attribute.
      Parameters:
      value - 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 java.text.SimpleDateFormat and "%YYYY;%MM;%DD;-%hh;h%mm;m%ss;s".
      Returns:
      possible object is String

    • setRotationSuffix

      void setRotationSuffix(String value) throws PropertyVetoException
      Sets the value of the rotation-suffix attribute.
      Parameters:
      value - 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 value) throws PropertyVetoException
      Sets the value of the rotation-enabled attribute.
      Parameters:
      value - 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 value)

    • 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 value)

    • 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 value) throws PropertyVetoException
      Sets the maximum number of rotated access log files that are to be kept.
      Parameters:
      value - the maximum number of log files
      Throws:
      PropertyVetoException - if a listener vetoes the change