Package com.sun.identity.log.messageid

Class LogMessageProviderBase

java.lang.Object

com.sun.identity.log.messageid.LogMessageProviderBase

All Implemented Interfaces:

LogMessageProvider

public class LogMessageProviderBase
extends Object
implements LogMessageProvider

This is the base class for all Log Message Provider class. It provides methods to generate XML for documenting log message.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LogMessageProviderBase(String xmlDef)

Method Summary

Modifier and Type	Method	Description
LogRecord	createLogRecord(String messageIDName, String[] dataInfo, Object ssoToken)	Returns Log Record.
LogRecord	createLogRecord(String messageIDName, String[] dataInfo, Hashtable ssoProperties)	Returns Log Record.
Map<String,LogMessageID>	getAllHashMessageIDs()	Returns all hash message IDs.
List	getAllMessageIDs()	Returns all message IDs.
protected void	registerMessageIDs()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogMessageProviderBase

protected LogMessageProviderBase(String xmlDef)
                          throws IOException

Throws:

IOException

Method Detail

getAllMessageIDs

public List getAllMessageIDs()

Returns all message IDs.

Specified by:

getAllMessageIDs in interface LogMessageProvider

Returns:

all message IDs.

getAllHashMessageIDs

public Map<String,LogMessageID> getAllHashMessageIDs()

Returns all hash message IDs. That is, the message IDs and their corresponding values.

Specified by:

getAllHashMessageIDs in interface LogMessageProvider

Returns:

all hash message IDs.

createLogRecord

public LogRecord createLogRecord(String messageIDName,
                                 String[] dataInfo,
                                 Object ssoToken)

Returns Log Record. null is returned if there are no corresponding entries in the XML definition file match with the messageIDName.

Specified by:

createLogRecord in interface LogMessageProvider

Parameters:

messageIDName - Name of Message ID.

dataInfo - Array of dataInfo.

ssoToken - Single sign on token which will be used to fill in details like client IP address into the log record.

Returns:

Log Record.

createLogRecord

public LogRecord createLogRecord(String messageIDName,
                                 String[] dataInfo,
                                 Hashtable ssoProperties)

Returns Log Record. null is returned if there are no corresponding entries in the XML definition file match with the messageIDName.

Parameters:

messageIDName - Name of Message ID.

dataInfo - Array of dataInfo.

ssoProperties - Hashtable which will be used to fill in details like client IP address into the log record.

Returns:

Log Record.

registerMessageIDs

protected void registerMessageIDs()
                           throws IOException

Throws:

IOException