Package com.sun.identity.coretoken

Class TokenLogUtils

java.lang.Object

com.sun.identity.coretoken.TokenLogUtils

public class TokenLogUtils
extends Object

The TokenLogUtils class defines methods which are used by Core Token Service to write access and erro logs.

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXPIRED_TOKEN_DELETE_SUCCESS
static String	TOKEN_CREATE_SUCCESS
static String	TOKEN_DELETE_SUCCESS
static String	TOKEN_NAME_ID
static String	TOKEN_READ_SUCCESS
static String	TOKEN_SEARCH_SUCCESS
static String	TOKEN_UPDATE_SUCCESS
static String	UNABLE_TO_CREATE_TOKEN
static String	UNABLE_TO_DELETE_TOKEN
static String	UNABLE_TO_READ_TOKEN
static String	UNABLE_TO_SEARCH_TOKEN
static String	UNABLE_TO_UPDATE_TOKEN

Constructor Summary

Constructors

Constructor	Description
TokenLogUtils()

Method Summary

Modifier and Type	Method	Description
static void	access(Level level, String msgid, String[] data, SSOToken session, String nameId)	Logs message to core token access logs.
static void	error(Level level, String msgid, String[] data, SSOToken session, String nameId)	Logs error messages to core token error log.
static boolean	isAccessLoggable(Level level)	Checks if an access message of the given level would actually be logged by this logger.
static boolean	isErrorLoggable(Level level)	Checks if an error message of the given level would actually be logged by this logger.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_CREATE_SUCCESS

public static final String TOKEN_CREATE_SUCCESS

See Also:

Constant Field Values

TOKEN_READ_SUCCESS

public static final String TOKEN_READ_SUCCESS

See Also:

Constant Field Values

TOKEN_UPDATE_SUCCESS

public static final String TOKEN_UPDATE_SUCCESS

See Also:

Constant Field Values

TOKEN_SEARCH_SUCCESS

public static final String TOKEN_SEARCH_SUCCESS

See Also:

Constant Field Values

TOKEN_DELETE_SUCCESS

public static final String TOKEN_DELETE_SUCCESS

See Also:

Constant Field Values

EXPIRED_TOKEN_DELETE_SUCCESS

public static final String EXPIRED_TOKEN_DELETE_SUCCESS

See Also:

Constant Field Values

UNABLE_TO_CREATE_TOKEN

public static final String UNABLE_TO_CREATE_TOKEN

See Also:

Constant Field Values

UNABLE_TO_READ_TOKEN

public static final String UNABLE_TO_READ_TOKEN

See Also:

Constant Field Values

UNABLE_TO_UPDATE_TOKEN

public static final String UNABLE_TO_UPDATE_TOKEN

See Also:

Constant Field Values

UNABLE_TO_SEARCH_TOKEN

public static final String UNABLE_TO_SEARCH_TOKEN

See Also:

Constant Field Values

UNABLE_TO_DELETE_TOKEN

public static final String UNABLE_TO_DELETE_TOKEN

See Also:

Constant Field Values

TOKEN_NAME_ID

public static final String TOKEN_NAME_ID

See Also:

Constant Field Values

Constructor Detail

TokenLogUtils

public TokenLogUtils()

Method Detail

access

public static void access(Level level,
                          String msgid,
                          String[] data,
                          SSOToken session,
                          String nameId)

Logs message to core token access logs.

Parameters:

level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :

• SEVERE (highest value)
  
• WARNING
  
• INFO
  
• CONFIG
  
• FINE
  
• FINER
  
• FINEST (lowest value)
  

msgid - the message or a message identifier.

data - string array of dynamic data to be replaced in the message.

session - the User's session object

nameId - value for NameID logging field

error

public static void error(Level level,
                         String msgid,
                         String[] data,
                         SSOToken session,
                         String nameId)

Logs error messages to core token error log.

Parameters:

level - the log level , these are based on those defined in java.util.logging.Level, the values for level can be any one of the following :

• SEVERE (highest value)
  
• WARNING
  
• INFO
  
• CONFIG
  
• FINE
  
• FINER
  
• FINEST (lowest value)
  

msgid - the message or a message identifier.

data - string array of dynamic data to be replaced in the message.

session - the User's Session object.

nameId - value for NameID logging field

isAccessLoggable

public static boolean isAccessLoggable(Level level)

Checks if an access message of the given level would actually be logged by this logger. This check is based on the Logger's effective level.

Parameters:

level - a message logging level defined in java.util.logging.Level.

Returns:

true if the given message level is currently being logged.

isErrorLoggable

public static boolean isErrorLoggable(Level level)

Checks if an error message of the given level would actually be logged by this logger. This check is based on the Logger's effective level.

Parameters:

level - a message logging level defined in java.util.logging.Level.

Returns:

true if the given message level is currently being logged.