com.sun.identity.log
Class LogRecord

java.lang.Object
  extended byjava.util.logging.LogRecord
      extended bycom.sun.identity.log.LogRecord
All Implemented Interfaces:
java.io.Serializable

public class LogRecord
extends java.util.logging.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
 

See Also:
Serialized Form

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 log information map, the field key and its corresponding value.
 java.util.Map getLogInfoMap()
          Returns the log information map which contains the set of fields and their corresponding values.
 void setLogInfoMap(java.util.Map logInfoMap)
          Convenience method to set the log information map.
 
Methods inherited from class java.util.logging.LogRecord
getLevel, getLoggerName, getMessage, getMillis, getParameters, getResourceBundle, getResourceBundleName, getSequenceNumber, getSourceClassName, getSourceMethodName, getThreadID, getThrown, setLevel, setLoggerName, setMessage, setMillis, setParameters, setResourceBundle, setResourceBundleName, setSequenceNumber, setSourceClassName, setSourceMethodName, setThreadID, setThrown
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 single sign on token 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 log information map, 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 log information map.

Parameters:
logInfoMap - Handler to the map which contains the log info

getLogInfoMap

public java.util.Map getLogInfoMap()
Returns the log information map which contains the set of fields and their corresponding values.

Returns:
The log information map.


Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.