com.sun.identity.log
Class LogRecord

com.sun.identity.log.LogRecord

public class LogRecord

Extension to the JDK1.4 LogRecord to include the logInfo HashMap and methods to store and retrieve data from this logInfo Map. The logInfo Map is supposed to be used by the client to fill in log-details which will be used by the Formatter to construct the actual log string. For JDK1.4 LogRecord please refer to http://java.sun.com/j2se/1.4.1/docs/api/java/util/logging/LogRecord.html


Constructor Summary
LogRecord(java.util.logging.Level level, java.lang.String msg)
          Construct the LogRecord with the given Level and message values.
LogRecord(java.util.logging.Level level, java.lang.String msg, java.lang.Object token)
          Construct the LogRecord with the given Level and message values.
 
Method Summary
 void addLogInfo(java.lang.String key, java.lang.Object value)
          Adds to the HashMap, the field key and its corresponding value.
 java.util.Map getLogInfoMap()
          Returns the logInfo HashMap which contains the set of fields and their corresponding values.
 void setLogInfoMap(java.util.Map logInfoMap)
          Convenience method to set the logInfo HashMap
 

Constructor Detail

LogRecord

public LogRecord(java.util.logging.Level level,
                 java.lang.String msg)
Construct the LogRecord with the given Level and message values.
Parameters:
level - The log Level
msg - The message string

LogRecord

public LogRecord(java.util.logging.Level level,
                 java.lang.String msg,
                 java.lang.Object token)
Construct the LogRecord with the given Level and message values.
Parameters:
level - The log Level
msg - The message string
token - The SSOToken which will be used to fill in details like client IP address into the LogRecord.
Method Detail

addLogInfo

public void addLogInfo(java.lang.String key,
                       java.lang.Object value)
Adds to the HashMap, the field key and its corresponding value.
Parameters:
key - The key which will be used by the formatter to determine if this piece of info is supposed to be added to the log string according to the selected log fields
value - The value which may form a part of the actual log-string.

setLogInfoMap

public void setLogInfoMap(java.util.Map logInfoMap)
Convenience method to set the logInfo HashMap
Parameters:
logInfoMap - Handler to the map which contains the log info

getLogInfoMap

public java.util.Map getLogInfoMap()
Returns the logInfo HashMap which contains the set of fields and their corresponding values.
Returns:
The logInfo map