com.sun.jbi.ui.common

Class ESBResultFormatter

java.lang.Object

com.sun.jbi.ui.common.ESBResultFormatter

public class ESBResultFormatter
extends Object

this class creates formatted text from the esb admin result.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_VAR_MARKER_ID application varaible name marker in the msg/exp list
static String	CAS_KEY CAS msg/exp list key in the instance Maps
static int	CAS_MSG_FORMAT cas msg format
static int	COMP_MSG_FORMAT component msg format
static String	ERROR error message type
static String	EXCEPTION error message type
static String	FAILED failed status
static String	INFO info message type
static int	INST_MSG_FORMAT instance msg format
static String	INSTANCE_MARKER_ID instance name marker in the msg/exp list
static String	OUT_DEBUG
static String	OUT_NORMAL
static String	OUT_VERBOSE
static String	SUCCESS success status
static int	TOP_MSG_FORMAT same as cas msg format
static String	UNKNOWN unknown value for any unknonw value of any msg status or type.
static String	WARNING warning message type

Constructor Summary

Constructors

Constructor and Description
ESBResultFormatter()
ESBResultFormatter(String outLevel) Creates a new instance of AdminResultFormatter

Method Summary

Methods

Modifier and Type	Method and Description
JBIManagementMessage.TaskResultInfo	createTaskResultInfo(JBIManagementMessage.TaskResultInfo taskResultInfo, List msgList, List expList) copy the id, resutl, msgtype from the taskresultinfo passed and create a new TaskResultInfo with them and the passed msg, exp lists.
protected String	get2ndExceptionMsgI18NKey(int formatType) message format type i18n key
protected String	get2ndMessageI18NKey(int formatType) message format type i18n key
protected String	getExceptionMsgI18NKey(int formatType) message format type i18n key
String	getFormattedESBResult(JBIManagementMessage jbiMsg) return the formatted message if you can create. else return null
String	getFormattedESBResult(String jbiMgmtMsgXml) return the formatted message if you can create. else return null
String	getFormattedResult(JBIManagementMessage.ESBTaskResult esbResult) creates formatted esb results
static I18NBundle	getI18NBundle() gives the I18N bundle
protected String	getL10N2ndExptionMessageForAppVar(String appVarName) creates l10n message in exceptin format
protected String	getL10NExptionMessage(String code, String msg) creates l10n message in exceptin format
protected String	getL10NExptionMessageForAppVar(String appVarName) creates l10n message in exceptin format
protected String	getL10NMainMessage(String msgType, String code, String msg) formats the message
protected String	getL10NMainMessageForAppVar(String msgType, String appVarName) formats the message
protected String	getL10NMessage(String code, String msg) creates l10n message
protected String	getL10NMessageForAppVar(String appVarName) creates l10n message
protected String	getL10NMessageType(String msgType) message type from i18n bundle
protected String	getMainMessageI18NKey(int formatType) message format type i18n key
protected void	print2ndExceptionMessage(PrintWriter out, int formatType, String msgCode, String msg) prints message to the output
protected void	print2ndMessage(PrintWriter out, int formatType, String msgCode, String msg) prints message to the output
protected boolean	printAllFormattedMessages(PrintWriter out, int formatType, String msgType, List msgList, List expList, boolean startWithNewLine) prints the messages from message list
boolean	printComponentLevelMessages(PrintWriter out, JBIManagementMessage.ComponentTaskResult compTaskResult) prints the messages
boolean	printESBTaskResult(PrintWriter out, JBIManagementMessage.ESBTaskResult esbResult) prints the messages
protected void	printExceptionMessage(PrintWriter out, int formatType, String msgCode, String msg) prints message to the output
protected boolean	printFormattedExceptionMessages(PrintWriter out, int formatType, String msgType, List expList, boolean printMainMsg) prints the messages from message list
protected boolean	printFormattedStatusMessages(PrintWriter out, int formatType, String msgType, List msgList) prints the messages from message list
boolean	printFrameworkLevelMessages(PrintWriter out, JBIManagementMessage.FrameworkTaskResult fwTaskResult) prints the messages
boolean	printInstanceLevelMessages(PrintWriter out, JBIManagementMessage.InstanceTaskResult instResult) prints the messages
boolean	printInstanceLevelMessages(PrintWriter out, JBIManagementMessage.InstanceTaskResult instResult, boolean printInstanceName) prints the messages
boolean	printJbiTaskResultMessages(PrintWriter out, JBIManagementMessage.JBITaskResult jbiTaskResult) prints the messages
protected void	printMainMessage(PrintWriter out, int formatType, String msgType, String msgCode, String msg) prints message to the output
boolean	printTaskResultMessages(PrintWriter out, int formatType, JBIManagementMessage.TaskResultInfo taskResultInfo) prints the messages
boolean	printTaskResultMessages(PrintWriter out, JBIManagementMessage.TaskResultInfo taskResultInfo) prints the messages
void	sortComponentTaskResultList(List compTaskResultList) sort the list
void	sortInstanceResultList(List instResultList) sort the list
JBIManagementMessage.ESBTaskResult	toESBTaskResult(JBIManagementMessage jbiMsg)
void	updateInstanceMap(Map instMap, JBIManagementMessage.ComponentTaskResult compResult, Map msgMap, Map expMap)
void	updateInstanceMap(Map instMap, JBIManagementMessage.FrameworkTaskResult fwTaskResult, Map fwInstMsgMap, Map fwInstExpMap)

Methods inherited from class java.lang.Object

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

Field Detail

TOP_MSG_FORMAT

public static final int TOP_MSG_FORMAT

same as cas msg format

See Also:

Constant Field Values

CAS_MSG_FORMAT

public static final int CAS_MSG_FORMAT

cas msg format

See Also:

Constant Field Values

INST_MSG_FORMAT

public static final int INST_MSG_FORMAT

instance msg format

See Also:

Constant Field Values

COMP_MSG_FORMAT

public static final int COMP_MSG_FORMAT

component msg format

See Also:

Constant Field Values

FAILED

public static final String FAILED

failed status

See Also:

Constant Field Values

SUCCESS

public static final String SUCCESS

success status

See Also:

Constant Field Values

INFO

public static final String INFO

info message type

See Also:

Constant Field Values

WARNING

public static final String WARNING

warning message type

See Also:

Constant Field Values

ERROR

public static final String ERROR

error message type

See Also:

Constant Field Values

EXCEPTION

public static final String EXCEPTION

error message type

See Also:

Constant Field Values

UNKNOWN

public static final String UNKNOWN

unknown value for any unknonw value of any msg status or type.

See Also:

Constant Field Values

INSTANCE_MARKER_ID

public static final String INSTANCE_MARKER_ID

instance name marker in the msg/exp list

See Also:

Constant Field Values

APP_VAR_MARKER_ID

public static final String APP_VAR_MARKER_ID

application varaible name marker in the msg/exp list

See Also:

Constant Field Values

CAS_KEY

public static final String CAS_KEY

CAS msg/exp list key in the instance Maps

See Also:

Constant Field Values

OUT_NORMAL

public static final String OUT_NORMAL

See Also:

Constant Field Values

OUT_VERBOSE

public static final String OUT_VERBOSE

See Also:

Constant Field Values

OUT_DEBUG

public static final String OUT_DEBUG

See Also:

Constant Field Values

Constructor Detail

ESBResultFormatter

public ESBResultFormatter()

ESBResultFormatter

public ESBResultFormatter(String outLevel)

Creates a new instance of AdminResultFormatter

Method Detail

getI18NBundle

public static I18NBundle getI18NBundle()

gives the I18N bundle

Returns:

I18NBundle object

getL10NMessage

protected String getL10NMessage(String code,
                    String msg)

creates l10n message

Parameters:

code - message code

msg - message

Returns:

formatted message

getL10NMessageForAppVar

protected String getL10NMessageForAppVar(String appVarName)

creates l10n message

Parameters:

appVarName -

Returns:

formatted message

getL10NExptionMessage

protected String getL10NExptionMessage(String code,
                           String msg)

creates l10n message in exceptin format

Parameters:

code - message code

msg - message

Returns:

formatted message

getL10NExptionMessageForAppVar

protected String getL10NExptionMessageForAppVar(String appVarName)

creates l10n message in exceptin format

Parameters:

appVarName -

Returns:

formatted message

getL10N2ndExptionMessageForAppVar

protected String getL10N2ndExptionMessageForAppVar(String appVarName)

creates l10n message in exceptin format

Parameters:

appVarName -

Returns:

formatted message

getL10NMessageType

protected String getL10NMessageType(String msgType)

message type from i18n bundle

Parameters:

msgType - message type

Returns:

message type

getL10NMainMessage

protected String getL10NMainMessage(String msgType,
                        String code,
                        String msg)

formats the message

Parameters:

msgType - message type

code - message code

msg - message

Returns:

formatted message

getL10NMainMessageForAppVar

protected String getL10NMainMessageForAppVar(String msgType,
                                 String appVarName)

formats the message

Parameters:

msgType - message type

appVarName - message

Returns:

formatted message

getMainMessageI18NKey

protected String getMainMessageI18NKey(int formatType)

message format type i18n key

Parameters:

formatType - format type

Returns:

i18n key

get2ndMessageI18NKey

protected String get2ndMessageI18NKey(int formatType)

message format type i18n key

Parameters:

formatType - format type

Returns:

i18n key

getExceptionMsgI18NKey

protected String getExceptionMsgI18NKey(int formatType)

message format type i18n key

Parameters:

formatType - format type

Returns:

i18n key

get2ndExceptionMsgI18NKey

protected String get2ndExceptionMsgI18NKey(int formatType)

message format type i18n key

Parameters:

formatType - format type

Returns:

i18n key

printMainMessage

protected void printMainMessage(PrintWriter out,
                    int formatType,
                    String msgType,
                    String msgCode,
                    String msg)

prints message to the output

Parameters:

out - print writer to print the message

formatType - format type

msgType - message type

msgCode - message code

msg - message

print2ndMessage

protected void print2ndMessage(PrintWriter out,
                   int formatType,
                   String msgCode,
                   String msg)

prints message to the output

Parameters:

out - print writer to print the message

formatType - format type

msgCode - message code

msg - message

printExceptionMessage

protected void printExceptionMessage(PrintWriter out,
                         int formatType,
                         String msgCode,
                         String msg)

prints message to the output

Parameters:

out - print writer to print the message

formatType - format type

msgCode - message code

msg - message

print2ndExceptionMessage

protected void print2ndExceptionMessage(PrintWriter out,
                            int formatType,
                            String msgCode,
                            String msg)

prints message to the output

Parameters:

out - print writer to print the message

formatType - format type

msgCode - message code

msg - message

printFormattedStatusMessages

protected boolean printFormattedStatusMessages(PrintWriter out,
                                   int formatType,
                                   String msgType,
                                   List msgList)

prints the messages from message list

Parameters:

out - print writer to print the message

formatType - format type

msgType - message type

msgList - list of TaskStatusMsgType objects

Returns:

true if any message is printed, false if no msg is printed.

printFormattedExceptionMessages

protected boolean printFormattedExceptionMessages(PrintWriter out,
                                      int formatType,
                                      String msgType,
                                      List expList,
                                      boolean printMainMsg)

prints the messages from message list

Parameters:

out - print writer to print the message

formatType - format type

msgType - message type

expList - list of ExceptionInfoType objects

printMainMsg - true prints the first message as main message format

Returns:

true if any message is printed, false if no msg is printed.

printAllFormattedMessages

protected boolean printAllFormattedMessages(PrintWriter out,
                                int formatType,
                                String msgType,
                                List msgList,
                                List expList,
                                boolean startWithNewLine)

prints the messages from message list

Parameters:

out - print writer to print the message

formatType - format type

msgType - message type

msgList - list of TaskStatusMsgType objects

expList - list of ExceptionInfoType objects

startWithNewLine - true prints the first message in new line

Returns:

true if any message is printed, false if no msg is printed.

printTaskResultMessages

public boolean printTaskResultMessages(PrintWriter out,
                              int formatType,
                              JBIManagementMessage.TaskResultInfo taskResultInfo)

prints the messages

Parameters:

out - print writer to print the message

formatType - format type

taskResultDetailsType - TaskResultDetailsType object

Returns:

true if any message is printed, false if no msg is printed.

printTaskResultMessages

public boolean printTaskResultMessages(PrintWriter out,
                              JBIManagementMessage.TaskResultInfo taskResultInfo)

prints the messages

Parameters:

taskResultDetailsType - TaskResultDetailsType object

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

printFrameworkLevelMessages

public boolean printFrameworkLevelMessages(PrintWriter out,
                                  JBIManagementMessage.FrameworkTaskResult fwTaskResult)

prints the messages

Parameters:

fwTaskResultType - frmwkTaskResultType object

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

printComponentLevelMessages

public boolean printComponentLevelMessages(PrintWriter out,
                                  JBIManagementMessage.ComponentTaskResult compTaskResult)

prints the messages

Parameters:

compTaskResultType - ComponentTaskResultType object

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

sortComponentTaskResultList

public void sortComponentTaskResultList(List compTaskResultList)

sort the list

Parameters:

compTaskResultList - list.

printJbiTaskResultMessages

public boolean printJbiTaskResultMessages(PrintWriter out,
                                 JBIManagementMessage.JBITaskResult jbiTaskResult)

prints the messages

Parameters:

jbiTaskResultType - JbiTaskResultType object

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

printInstanceLevelMessages

public boolean printInstanceLevelMessages(PrintWriter out,
                                 JBIManagementMessage.InstanceTaskResult instResult,
                                 boolean printInstanceName)

prints the messages

Parameters:

instResultDetailType - InstanceResultDetailType object

printInstanceName - true prints the instance name, false prints no instance name.

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

printInstanceLevelMessages

public boolean printInstanceLevelMessages(PrintWriter out,
                                 JBIManagementMessage.InstanceTaskResult instResult)

prints the messages

Parameters:

instResultDetailType - InstanceResultDetailType object

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

sortInstanceResultList

public void sortInstanceResultList(List instResultList)

sort the list

Parameters:

instResultList - list.

printESBTaskResult

public boolean printESBTaskResult(PrintWriter out,
                         JBIManagementMessage.ESBTaskResult esbResult)

prints the messages

Parameters:

esbResultType - EsbTaskResultType object

out - print writer to print the message

Returns:

true if any message is printed, false if no msg is printed.

createTaskResultInfo

public JBIManagementMessage.TaskResultInfo createTaskResultInfo(JBIManagementMessage.TaskResultInfo taskResultInfo,
                                                       List msgList,
                                                       List expList)

copy the id, resutl, msgtype from the taskresultinfo passed and create a new TaskResultInfo with them and the passed msg, exp lists. This will be used in re-creating the taskresultinfo per instance from the main jbi mgmt msg task result info at framework level and component level

updateInstanceMap

public void updateInstanceMap(Map instMap,
                     JBIManagementMessage.FrameworkTaskResult fwTaskResult,
                     Map fwInstMsgMap,
                     Map fwInstExpMap)

updateInstanceMap

public void updateInstanceMap(Map instMap,
                     JBIManagementMessage.ComponentTaskResult compResult,
                     Map msgMap,
                     Map expMap)

toESBTaskResult

public JBIManagementMessage.ESBTaskResult toESBTaskResult(JBIManagementMessage jbiMsg)

getFormattedResult

public String getFormattedResult(JBIManagementMessage.ESBTaskResult esbResult)

creates formatted esb results

Parameters:

esbResult - esb results object

Returns:

formatted text

getFormattedESBResult

public String getFormattedESBResult(JBIManagementMessage jbiMsg)

return the formatted message if you can create. else return null

Parameters:

jbiMgmtMsgXml - string contains the xml confirms to the JbiManagementMessage schema

Returns:

the formatted message if you can create. else return null

getFormattedESBResult

public String getFormattedESBResult(String jbiMgmtMsgXml)

return the formatted message if you can create. else return null

Parameters:

jbiMgmtMsgXml - string contains the xml confirms to the JbiManagementMessage schema

Returns:

the formatted message if you can create. else return null