com.sun.identity.log
Class LogConstants

java.lang.Object
  |
  +--com.sun.identity.log.LogConstants

public class LogConstants

extends java.lang.Object

Defines constants used in the Logging service. LogConstants helps in maintaining a central repository of all the constants used in the package.

Field Summary

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

Constructor Summary

LogConstants()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FILE_SIZE

public static final java.lang.String MAX_FILE_SIZE

Attribute defining the maximum (flat) file size, above which the files are either archived or rotated.

LOG_LOCATION

public static final java.lang.String LOG_LOCATION

Attribute defining the location where the logs go.

BACKEND

public static final java.lang.String BACKEND

Attribute defining whether the logs to be stored in flat-files or to a Database.

DB_DRIVER

public static final java.lang.String DB_DRIVER

Attribute defining the Database Driver.

ALL_FIELDS

public static final java.lang.String ALL_FIELDS

Attribute defining the set of all fields being logged. These fields are predefined to be time, Date, LoginID, Domain, LogLevel, Data, IPAddr, and HostName.

LOG_FIELDS

public static final java.lang.String LOG_FIELDS

Attribute defining the fields currently selected by the administrator to be logged.

NUM_HISTORY_FILES

public static final java.lang.String NUM_HISTORY_FILES

Attribute defining the number of history files a (flat file) log should have.

CRLF

public static final java.lang.String CRLF

Defines CarriageReturn/LineFeed characters.

LOGGING_SERVICE

public static final java.lang.String LOGGING_SERVICE

Defines the LoggingService name.

DEBUG_IMPL_CLASS

public static final java.lang.String DEBUG_IMPL_CLASS

Attribute defining the Class that implements the custom debug method in the case of log failure.

BUFFER_SIZE

public static final java.lang.String BUFFER_SIZE

Attribute defining the Buffer size.

DB_MEM_MAX_RECS

public static final java.lang.String DB_MEM_MAX_RECS

Attribute defining the Maximum LogRecords held in memory if DB logging fails.

BUFFER_TIME

public static final java.lang.String BUFFER_TIME

Attribute defining the Buffering time.

TIME_BUFFERING_STATUS

public static final java.lang.String TIME_BUFFERING_STATUS

Attribute defining the Time Buffering Status; ON or OFF.

LOG_STATUS

public static final java.lang.String LOG_STATUS

Property defining whether logging is enabled

TIME

public static final java.lang.String TIME

The Date/Time field. This field is one of the two required in any log record.

DATA

public static final java.lang.String DATA

The Data field. This field is one of the two required in any log record.

LOG_LEVEL

public static final java.lang.String LOG_LEVEL

The LogLevel field. The level at which the log record was logged.

DOMAIN

public static final java.lang.String DOMAIN

The Domain field. The AM Domain pertaining to the log record's Data field.

LOGIN_ID

public static final java.lang.String LOGIN_ID

The LoginID field. The AM Login ID pertaining to the log record's Data field.

IP_ADDR

public static final java.lang.String IP_ADDR

The IPAddr field. The IP Address pertaining to the log record's Data field.

HOST_NAME

public static final java.lang.String HOST_NAME

The HostName field. The HostName pertaining to the log record's Data field.

MODULE_NAME

public static final java.lang.String MODULE_NAME

The ModuleName field. The AM Module pertaining to the log record's Data field.

LOGGED_BY

public static final java.lang.String LOGGED_BY

The LoggedBy field. The ID associated with who logged the record.

CONTEXT_ID

public static final java.lang.String CONTEXT_ID

The ContextID field. The ID associated with the user's session that is the subject of this log record.

MESSAGE_ID

public static final java.lang.String MESSAGE_ID

The MessageID field. The unique Message Identifier associated with this particular log record data field.

Constructor Detail

LogConstants

public LogConstants()