com.sun.identity.cot

Class LogUtil

java.lang.Object

com.sun.identity.cot.LogUtil

public class LogUtil
extends Object

The LogUtil class provides methods which are used by circle of trust manager to write logs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_ERROR_ADD_COT_MEMBER
static String	CONFIG_ERROR_CREATE_COT_DESCRIPTOR
static String	CONFIG_ERROR_DELETE_COT_DESCRIPTOR
static String	CONFIG_ERROR_GET_ALL_ACTIVE_COT
static String	CONFIG_ERROR_GET_ALL_COT_DESCRIPTOR
static String	CONFIG_ERROR_GET_COT_DESCRIPTOR
static String	CONFIG_ERROR_LIST_COT_MEMBER
static String	CONFIG_ERROR_MODIFY_COT_DESCRIPTOR
static String	CONFIG_ERROR_REMOVE_COT_MEMBER
static String	CONFIG_ERROR_RETREIVE_COT
static String	COT_DESCRIPTOR_CREATED
static String	COT_DESCRIPTOR_DELETED
static String	COT_DESCRIPTOR_RETRIEVED
static String	COT_EXISTS_CREATE_COT_DESCRIPTOR
static String	COT_FROM_CACHE
static String	HAS_ENTITIES_DELETE_COT_DESCRIPTOR
static String	INVALID_COT_NAME
static String	INVALID_COT_TYPE
static String	INVALID_COT_TYPE_DELETE_COT_DESCRIPTOR
static String	INVALID_NAME_ERROR_DELETE_COT_DESCRIPTOR
static String	NO_COT_NAME_CREATE_COT_DESCRIPTOR
static String	NULL_COT_NAME_ADD_COT_DESCRIPTOR
static String	NULL_COT_NAME_LIST_COT
static String	NULL_COT_NAME_REMOVE_COT_MEMBER
static String	NULL_ENTITYID_ADD_COT_DESCRIPTOR
static String	NULL_ENTITYID_REMOVE_COT_MEMBER

Constructor Summary

Constructors

Constructor and Description
LogUtil()

Method Summary

Modifier and Type	Method and Description
static void	access(Level level, String msgid, String[] data) Logs message to COT access logs.
static void	access(Level level, String msgid, String[] data, Object session) Logs message to COT access logs.
static void	error(Level level, String msgid, String[] data) Logs error messages to COT error log.
static void	error(Level level, String msgid, String[] data, Object session) Logs error messages to COT 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.
boolean	isLogEnabled() Checks if the logging is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_COT_NAME

public static final String INVALID_COT_NAME

See Also:

Constant Field Values

CONFIG_ERROR_MODIFY_COT_DESCRIPTOR

public static final String CONFIG_ERROR_MODIFY_COT_DESCRIPTOR

See Also:

Constant Field Values

CONFIG_ERROR_GET_ALL_COT_DESCRIPTOR

public static final String CONFIG_ERROR_GET_ALL_COT_DESCRIPTOR

See Also:

Constant Field Values

NO_COT_NAME_CREATE_COT_DESCRIPTOR

public static final String NO_COT_NAME_CREATE_COT_DESCRIPTOR

See Also:

Constant Field Values

COT_EXISTS_CREATE_COT_DESCRIPTOR

public static final String COT_EXISTS_CREATE_COT_DESCRIPTOR

See Also:

Constant Field Values

INVALID_COT_TYPE

public static final String INVALID_COT_TYPE

See Also:

Constant Field Values

CONFIG_ERROR_CREATE_COT_DESCRIPTOR

public static final String CONFIG_ERROR_CREATE_COT_DESCRIPTOR

See Also:

Constant Field Values

COT_DESCRIPTOR_CREATED

public static final String COT_DESCRIPTOR_CREATED

See Also:

Constant Field Values

NULL_COT_NAME_ADD_COT_DESCRIPTOR

public static final String NULL_COT_NAME_ADD_COT_DESCRIPTOR

See Also:

Constant Field Values

NULL_ENTITYID_ADD_COT_DESCRIPTOR

public static final String NULL_ENTITYID_ADD_COT_DESCRIPTOR

See Also:

Constant Field Values

CONFIG_ERROR_ADD_COT_MEMBER

public static final String CONFIG_ERROR_ADD_COT_MEMBER

See Also:

Constant Field Values

NULL_COT_NAME_REMOVE_COT_MEMBER

public static final String NULL_COT_NAME_REMOVE_COT_MEMBER

See Also:

Constant Field Values

NULL_ENTITYID_REMOVE_COT_MEMBER

public static final String NULL_ENTITYID_REMOVE_COT_MEMBER

See Also:

Constant Field Values

CONFIG_ERROR_REMOVE_COT_MEMBER

public static final String CONFIG_ERROR_REMOVE_COT_MEMBER

See Also:

Constant Field Values

NULL_COT_NAME_LIST_COT

public static final String NULL_COT_NAME_LIST_COT

See Also:

Constant Field Values

CONFIG_ERROR_LIST_COT_MEMBER

public static final String CONFIG_ERROR_LIST_COT_MEMBER

See Also:

Constant Field Values

COT_DESCRIPTOR_DELETED

public static final String COT_DESCRIPTOR_DELETED

See Also:

Constant Field Values

CONFIG_ERROR_DELETE_COT_DESCRIPTOR

public static final String CONFIG_ERROR_DELETE_COT_DESCRIPTOR

See Also:

Constant Field Values

INVALID_NAME_ERROR_DELETE_COT_DESCRIPTOR

public static final String INVALID_NAME_ERROR_DELETE_COT_DESCRIPTOR

See Also:

Constant Field Values

HAS_ENTITIES_DELETE_COT_DESCRIPTOR

public static final String HAS_ENTITIES_DELETE_COT_DESCRIPTOR

See Also:

Constant Field Values

INVALID_COT_TYPE_DELETE_COT_DESCRIPTOR

public static final String INVALID_COT_TYPE_DELETE_COT_DESCRIPTOR

See Also:

Constant Field Values

COT_FROM_CACHE

public static final String COT_FROM_CACHE

See Also:

Constant Field Values

COT_DESCRIPTOR_RETRIEVED

public static final String COT_DESCRIPTOR_RETRIEVED

See Also:

Constant Field Values

CONFIG_ERROR_GET_COT_DESCRIPTOR

public static final String CONFIG_ERROR_GET_COT_DESCRIPTOR

See Also:

Constant Field Values

CONFIG_ERROR_GET_ALL_ACTIVE_COT

public static final String CONFIG_ERROR_GET_ALL_ACTIVE_COT

See Also:

Constant Field Values

CONFIG_ERROR_RETREIVE_COT

public static final String CONFIG_ERROR_RETREIVE_COT

See Also:

Constant Field Values

Constructor Detail

LogUtil

public LogUtil()

Method Detail

access

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

Logs message to COT 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.

access

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

Logs message to COT 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

error

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

Logs error messages to COT 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.

error

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

Logs error messages to COT 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.

isLogEnabled

public boolean isLogEnabled()

Checks if the logging is enabled.

Returns:

true if logging is enabled.

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 Loggers effective level.

Parameters:

level - a message 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 Loggers effective level.

Parameters:

level - a message logging level.

Returns:

true if the given message level is currently being logged.