LogConstants (OpenAM Server Only 6.5.5 Documentation)

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

Deprecated.
since 14.0.0, use Common Audit Service
```
@Deprecated
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

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

Class LogConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_FILE_SIZE

LOG_LOCATION

BACKEND

DB_DRIVER

ALL_FIELDS

LOG_FIELDS

NUM_HISTORY_FILES

CRLF

LOGGING_SERVICE

DEBUG_IMPL_CLASS

BUFFER_SIZE

DB_MEM_MAX_RECS

BUFFER_TIME

TIME_BUFFERING_STATUS

LOG_STATUS

TIME

DATA

LOG_LEVEL

DOMAIN

LOGIN_ID

IP_ADDR

HOST_NAME

MODULE_NAME

LOGGED_BY

CONTEXT_ID

MESSAGE_ID

NAME_ID

MAX_FIELDS