Package com.sun.identity.log

Class LogConstants

java.lang.Object
com.sun.identity.log.LogConstants
@Supported @Deprecated(since="8.0.0", forRemoval=true) public class LogConstants extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Defines constants used in the Logging service. LogConstants helps in maintaining a central repository of all the constants used in the package.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ALL_FIELDS
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the set of all fields being logged.
    static final String
    BACKEND
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining whether the logs to be stored in flat-files or to a Database.
    static final String
    BUFFER_SIZE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the Buffer size.
    static final String
    BUFFER_TIME
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the Buffering time.
    static final String
    CONTEXT_ID
    Deprecated, for removal: This API element is subject to removal in a future version.
    The ContextID field.
    static final String
    CRLF
    Deprecated, for removal: This API element is subject to removal in a future version.
    Defines CarriageReturn/LineFeed characters.
    static final String
    DATA
    Deprecated, for removal: This API element is subject to removal in a future version.
    The Data field.
    static final String
    DB_DRIVER
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the Database Driver.
    static final String
    DB_MEM_MAX_RECS
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the Maximum LogRecords held in memory if DB logging fails.
    static final String
    DEBUG_IMPL_CLASS
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the Class that implements the custom debug method in the case of log failure.
    static final String
    DOMAIN
    Deprecated, for removal: This API element is subject to removal in a future version.
    The Domain field.
    static final String
    HOST_NAME
    Deprecated, for removal: This API element is subject to removal in a future version.
    The HostName field.
    static final String
    IP_ADDR
    Deprecated, for removal: This API element is subject to removal in a future version.
    The IPAddr field.
    static final String
    LOG_FIELDS
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the fields currently selected by the administrator to be logged.
    static final String
    LOG_LEVEL
    Deprecated, for removal: This API element is subject to removal in a future version.
    The LogLevel field.
    static final String
    LOG_LOCATION
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the location where the logs go.
    static final String
    LOG_STATUS
    Deprecated, for removal: This API element is subject to removal in a future version.
    Property defining whether logging is enabled
    static final String
    LOGGED_BY
    Deprecated, for removal: This API element is subject to removal in a future version.
    The LoggedBy field.
    static final String
    LOGGING_SERVICE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Defines the LoggingService name.
    static final String
    LOGIN_ID
    Deprecated, for removal: This API element is subject to removal in a future version.
    The LoginID field.
    static final int
    MAX_FIELDS
    Deprecated, for removal: This API element is subject to removal in a future version.
    The maximum number of fields in a "regular" record.
    static final String
    MAX_FILE_SIZE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the maximum (flat) file size, above which the files are either archived or rotated.
    static final String
    MESSAGE_ID
    Deprecated, for removal: This API element is subject to removal in a future version.
    The MessageID field.
    static final String
    MODULE_NAME
    Deprecated, for removal: This API element is subject to removal in a future version.
    The ModuleName field.
    static final String
    NAME_ID
    Deprecated, for removal: This API element is subject to removal in a future version.
    The NameID field.
    static final String
    NUM_HISTORY_FILES
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the number of history files a (flat file) log should have.
    static final String
    TIME
    Deprecated, for removal: This API element is subject to removal in a future version.
    The Date/Time field.
    static final String
    TIME_BUFFERING_STATUS
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attribute defining the Time Buffering Status; ON or OFF.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • MAX_FILE_SIZE

      @Supported public static final String MAX_FILE_SIZE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the maximum (flat) file size, above which the files are either archived or rotated.
      See Also:

    • LOG_LOCATION

      @Supported public static final String LOG_LOCATION
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the location where the logs go.
      See Also:

    • BACKEND

      @Supported public static final String BACKEND
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining whether the logs to be stored in flat-files or to a Database.
      See Also:

    • DB_DRIVER

      @Supported public static final String DB_DRIVER
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the Database Driver.
      See Also:

    • ALL_FIELDS

      @Supported public static final String ALL_FIELDS
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the set of all fields being logged. These fields are predefined to be time, Date, LoginID, Domain, LogLevel, Data, IPAddr, and HostName.
      See Also:

    • LOG_FIELDS

      @Supported public static final String LOG_FIELDS
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the fields currently selected by the administrator to be logged.
      See Also:

    • NUM_HISTORY_FILES

      @Supported public static final String NUM_HISTORY_FILES
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the number of history files a (flat file) log should have.
      See Also:

    • CRLF

      @Supported public static final String CRLF
      Deprecated, for removal: This API element is subject to removal in a future version.
      Defines CarriageReturn/LineFeed characters.
      See Also:

    • LOGGING_SERVICE

      @Supported public static final String LOGGING_SERVICE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Defines the LoggingService name.
      See Also:

    • DEBUG_IMPL_CLASS

      @Supported public static final String DEBUG_IMPL_CLASS
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the Class that implements the custom debug method in the case of log failure.
      See Also:

    • BUFFER_SIZE

      @Supported public static final String BUFFER_SIZE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the Buffer size.
      See Also:

    • DB_MEM_MAX_RECS

      @Supported public static final String DB_MEM_MAX_RECS
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the Maximum LogRecords held in memory if DB logging fails.
      See Also:

    • BUFFER_TIME

      @Supported public static final String BUFFER_TIME
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the Buffering time.
      See Also:

    • TIME_BUFFERING_STATUS

      @Supported public static final String TIME_BUFFERING_STATUS
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attribute defining the Time Buffering Status; ON or OFF.
      See Also:

    • LOG_STATUS

      @Supported public static final String LOG_STATUS
      Deprecated, for removal: This API element is subject to removal in a future version.
      Property defining whether logging is enabled
      See Also:

    • TIME

      @Supported public static final String TIME
      Deprecated, for removal: This API element is subject to removal in a future version.
      The Date/Time field. This field is one of the two required in any log record.
      See Also:

    • DATA

      @Supported public static final String DATA
      Deprecated, for removal: This API element is subject to removal in a future version.
      The Data field. This field is one of the two required in any log record.
      See Also:

    • LOG_LEVEL

      @Supported public static final String LOG_LEVEL
      Deprecated, for removal: This API element is subject to removal in a future version.
      The LogLevel field. The level at which the log record was logged.
      See Also:

    • DOMAIN

      @Supported public static final String DOMAIN
      Deprecated, for removal: This API element is subject to removal in a future version.
      The Domain field. The AM Domain pertaining to the log record's Data field.
      See Also:

    • LOGIN_ID

      @Supported public static final String LOGIN_ID
      Deprecated, for removal: This API element is subject to removal in a future version.
      The LoginID field. The AM Login ID pertaining to the log record's Data field.
      See Also:

    • IP_ADDR

      @Supported public static final String IP_ADDR
      Deprecated, for removal: This API element is subject to removal in a future version.
      The IPAddr field. The IP Address pertaining to the log record's Data field.
      See Also:

    • HOST_NAME

      @Supported public static final String HOST_NAME
      Deprecated, for removal: This API element is subject to removal in a future version.
      The HostName field. The HostName pertaining to the log record's Data field.
      See Also:

    • MODULE_NAME

      @Supported public static final String MODULE_NAME
      Deprecated, for removal: This API element is subject to removal in a future version.
      The ModuleName field. The AM Module pertaining to the log record's Data field.
      See Also:

    • LOGGED_BY

      @Supported public static final String LOGGED_BY
      Deprecated, for removal: This API element is subject to removal in a future version.
      The LoggedBy field. The ID associated with who logged the record.
      See Also:

    • CONTEXT_ID

      @Supported public static final String CONTEXT_ID
      Deprecated, for removal: This API element is subject to removal in a future version.
      The ContextID field. The ID associated with the user's session that is the subject of this log record.
      See Also:

    • MESSAGE_ID

      @Supported public static final String MESSAGE_ID
      Deprecated, for removal: This API element is subject to removal in a future version.
      The MessageID field. The unique Message Identifier associated with this particular log record data field.
      See Also:

    • NAME_ID

      @Supported public static final String NAME_ID
      Deprecated, for removal: This API element is subject to removal in a future version.
      The NameID field. The Name Identifier associated with this particular log record data field.
      See Also:

    • MAX_FIELDS

      @Supported public static final int MAX_FIELDS
      Deprecated, for removal: This API element is subject to removal in a future version.
      The maximum number of fields in a "regular" record. Includes Time, Data, LogLevel, Domain, LoginID, IPAddr, HostName, ModuleName, LoggedBy, ContextID, MessageID, NameID. Be sure to increment if more fields are added.
      See Also: