com.sun.identity.log
Class LogConstants

java.lang.Object
  com.sun.identity.log.LogConstants

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

Field Detail

MAX_FILE_SIZE

public static final String MAX_FILE_SIZE

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

See Also:

Constant Field Values

LOG_LOCATION

public static final String LOG_LOCATION

Attribute defining the location where the logs go.

See Also:

Constant Field Values

BACKEND

public static final String BACKEND

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

See Also:

Constant Field Values

DB_DRIVER

public static final String DB_DRIVER

Attribute defining the Database Driver.

See Also:

Constant Field Values

ALL_FIELDS

public static final 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.

See Also:

Constant Field Values

LOG_FIELDS

public static final String LOG_FIELDS

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

See Also:

Constant Field Values

NUM_HISTORY_FILES

public static final String NUM_HISTORY_FILES

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

See Also:

Constant Field Values

CRLF

public static final String CRLF

Defines CarriageReturn/LineFeed characters.

See Also:

Constant Field Values

LOGGING_SERVICE

public static final String LOGGING_SERVICE

Defines the LoggingService name.

See Also:

Constant Field Values

DEBUG_IMPL_CLASS

public static final String DEBUG_IMPL_CLASS

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

See Also:

Constant Field Values

BUFFER_SIZE

public static final String BUFFER_SIZE

Attribute defining the Buffer size.

See Also:

Constant Field Values

DB_MEM_MAX_RECS

public static final String DB_MEM_MAX_RECS

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

See Also:

Constant Field Values

BUFFER_TIME

public static final String BUFFER_TIME

Attribute defining the Buffering time.

See Also:

Constant Field Values

TIME_BUFFERING_STATUS

public static final String TIME_BUFFERING_STATUS

Attribute defining the Time Buffering Status; ON or OFF.

See Also:

Constant Field Values

LOG_STATUS

public static final String LOG_STATUS

Property defining whether logging is enabled

See Also:

Constant Field Values

TIME

public static final String TIME

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

See Also:

Constant Field Values

DATA

public static final String DATA

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

See Also:

Constant Field Values

LOG_LEVEL

public static final String LOG_LEVEL

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

See Also:

Constant Field Values

DOMAIN

public static final String DOMAIN

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

See Also:

Constant Field Values

LOGIN_ID

public static final String LOGIN_ID

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

See Also:

Constant Field Values

IP_ADDR

public static final String IP_ADDR

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

See Also:

Constant Field Values

HOST_NAME

public static final String HOST_NAME

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

See Also:

Constant Field Values

MODULE_NAME

public static final String MODULE_NAME

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

See Also:

Constant Field Values

LOGGED_BY

public static final String LOGGED_BY

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

See Also:

Constant Field Values

CONTEXT_ID

public static final String CONTEXT_ID

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

See Also:

Constant Field Values

MESSAGE_ID

public static final String MESSAGE_ID

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

See Also:

Constant Field Values

NAME_ID

public static final String NAME_ID

The NameID field. The Name Identifier associated with this particular log record data field.

See Also:

Constant Field Values

MAX_FIELDS

public static final int MAX_FIELDS

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:

Constant Field Values