Package com.sun.enterprise.config.serverbeans

Interface AccessLog

    • Method Detail

      • getFormat

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

      • getRotationPolicy

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

      • 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

      • getRotationEnabled

        String getRotationEnabled()
        Gets the value of the rotation-enabled attribute. The flag for enabling the access-log rotation
        Returns:
        possible object is String

      • getRotationOnDateChange

        String getRotationOnDateChange()

      • 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

      • getMaximumFileSize

        @NotNull
@NotNull String getMaximumFileSize()
        Gets the file size limit at which log will rotate.

        A value of 0 will disable log rotation based on file size

        Returns:
        log file size rotation limit

      • setMaximumFileSize

        void setMaximumFileSize​(String value)
                 throws PropertyVetoException
        Set size limit for log file at which it will rotate.
        Parameters:
        value - the limit for log file size
        Throws:
        PropertyVetoException - if a listener vetoes the change

      • getLogToConsoleEnabled

        String getLogToConsoleEnabled()
        Specifies whether to display access logs on the console
        Returns:
        true if logging to console

      • setLogToConsoleEnabled

        void setLogToConsoleEnabled​(boolean tf)
        specifies whether to display access logs to console
        Parameters:
        tf - true/false

      • getCondition

        String getCondition()
        Conditional logging filter
        Returns:
        the condition filter for the log

      • setCondition

        void setCondition​(String condition)
        Condition logging filter
        Parameters:
        condition - the condition filter for the log

      • getDateStampToFirstAccessLogFileEnabled

        String getDateStampToFirstAccessLogFileEnabled()
        Returns true if the first access log file and all subsequently rotated ones are supposed to be date-stamped, and false if datestamp is to be added only starting with the first rotation.
        Returns:
        true if first access log file and all subsequently rotated ones are supposed to be date-stamped, and false if datestamp is to be added only starting with the first rotation.

      • setDateStampToFirstAccessLogFileEnabled

        void setDateStampToFirstAccessLogFileEnabled​(String tf)
                                      throws PropertyVetoException
        Specifies whether date will be added to the first access log file or not
        Parameters:
        tf - true/false
        Throws:
        PropertyVetoException - if a listener vetoes the change