com.sun.jbi.ui.common

Class JBIManagementMessage

java.lang.Object

com.sun.jbi.ui.common.JBIManagementMessage

public class JBIManagementMessage
extends Object

This class represents the management message object that will be constructed from the xml string returned by the management apis to access various parts of the message. The factory method create is used to construct the dom for the xml text and parse the dom to construct this object.

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JBIManagementMessage.AbstractTaskResult base class for task result object.
static class	JBIManagementMessage.ComponentTaskResult class for component result
static class	JBIManagementMessage.ESBTaskResult class for esb task resutls that consists of {JBITaskResult, ESBInstanceTaskResult*}
static class	JBIManagementMessage.ExceptionInfo class for Exception info storage.
static class	JBIManagementMessage.FrameworkTaskResult class for Framework task results object
static class	JBIManagementMessage.InstanceTaskResult class for instance result in ESB
static class	JBIManagementMessage.JBIManagementMessageException This is the Exception takes the Manamagement Message object and prints the stacktrace information in the message as part of the stacktrace of the exception.
static class	JBIManagementMessage.JBIManagementMessageUnmarshaller to convert the management message xml to the JBIManagementMessageObject.
static class	JBIManagementMessage.JBITaskResult class for jbi task resutls that consists of {FrameworkTaskResult, ComponentTaskResult*}
static class	JBIManagementMessage.MessageInfo class for message inf object.
static class	JBIManagementMessage.TaskResultInfo class for task result object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR error message type
static String	EXCEPTION error message type
static String	FAILED failed status
static String	INFO info message type
static String	SUCCESS success status
static String	UNKNOWN unknown value for any unknonw value of any msg status or type.
static String	WARNING warning message type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JBIManagementMessage() Creates a new instance of JBIManagementMessage

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeWriter(Writer writer) closes the wirter without generationg the ioexception
static JBIManagementMessage	createJBIManagementMessage(String xmlText) factory method to create the message object
static JBIManagementMessage	createJBIManagementMessage(String taskId, Map<String,String> responseMap, boolean requireAllSuccess) Build a single management message from the entries in the map.
protected List	getAllMessagesForComponent(JBIManagementMessage.ComponentTaskResult compTaskResult)
protected List	getComponentTaskResultList() returns result list.
String	getDebugMessage() Returns a verbose output.
protected JBIManagementMessage.FrameworkTaskResult	getFrameworkTaskResult() get fw result object.
protected static String	getL10NMessageType(String msgType) returns the l10n msgtyep string for msgType
String	getMessage() returns the formatted message as a string
String	getMessage(String level) returns the formatted message as a string
String	getMessageDeprecated(String level) Deprecated.
String	getMessageType() check message type
protected List	getSortedComponentTaskResultList() returns result list.
String	getStackTrace() stacktrace
boolean	isErrorMsgType() check message type
boolean	isExceptionMsgType() check message type
boolean	isFailedMsg() check message status
boolean	isInfoMsgType() check message type
boolean	isSuccessMsg() check message status
boolean	isWarningMsg() check message status
boolean	isWarningMsgType() check message type
void	printDebugMessage(PrintWriter writer) prints message
void	printMessage(PrintStream s) override method
void	printMessage(PrintWriter writer) prints message
protected void	printMessageList(PrintWriter out, List msgList)
void	printStackTrace(PrintStream s) override method
void	printStackTrace(PrintWriter writer) prints stacktrace
static void	printWithIndentation(String prefix, String msg, PrintWriter writer) write string to the writer
protected void	setFrameworkTaskResult(JBIManagementMessage.FrameworkTaskResult frameworkTaskResult) sets fw result.

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

JBIManagementMessage

protected JBIManagementMessage()

Creates a new instance of JBIManagementMessage

Method Detail

setFrameworkTaskResult

protected void setFrameworkTaskResult(JBIManagementMessage.FrameworkTaskResult frameworkTaskResult)

sets fw result.

Parameters:

frameworkTaskResult - fw result object.

getFrameworkTaskResult

protected JBIManagementMessage.FrameworkTaskResult getFrameworkTaskResult()

get fw result object.

Returns:

fw result object.

getComponentTaskResultList

protected List getComponentTaskResultList()

returns result list.

Returns:

result list.

getSortedComponentTaskResultList

protected List getSortedComponentTaskResultList()

returns result list.

Returns:

result list.

isSuccessMsg

public boolean isSuccessMsg()

check message status

Returns:

true if status is SUCCESS else fasle

isFailedMsg

public boolean isFailedMsg()

check message status

Returns:

true if status is FAILED else fasle

isWarningMsg

public boolean isWarningMsg()

check message status

Returns:

true if it is warning message else fasle

getMessageType

public String getMessageType()

check message type

Returns:

msg type or null if no message type present

isWarningMsgType

public boolean isWarningMsgType()

check message type

Returns:

true if it is warning message type else fasle

isInfoMsgType

public boolean isInfoMsgType()

check message type

Returns:

true if it is info message type else fasle

isErrorMsgType

public boolean isErrorMsgType()

check message type

Returns:

true if it is error message type else fasle

isExceptionMsgType

public boolean isExceptionMsgType()

check message type

Returns:

true if it is error message type else fasle

printMessage

public void printMessage(PrintStream s)

override method

Parameters:

s - stream

getDebugMessage

public String getDebugMessage()

Returns a verbose output.

Returns:

debug message.

printDebugMessage

public void printDebugMessage(PrintWriter writer)

prints message

Parameters:

writer - writer

closeWriter

protected void closeWriter(Writer writer)

closes the wirter without generationg the ioexception

Parameters:

writer - Writer object

printMessageList

protected void printMessageList(PrintWriter out,
                    List msgList)

Parameters:

out -

msgList -

getAllMessagesForComponent

protected List getAllMessagesForComponent(JBIManagementMessage.ComponentTaskResult compTaskResult)

Parameters:

compTaskResult -

Returns:

getMessageDeprecated

public String getMessageDeprecated(String level)

Deprecated.

returns the formatted message as a string

Parameters:

level - Specifies the level of output ("verbose","normal","terse")

Returns:

message.

getMessage

public String getMessage(String level)

returns the formatted message as a string

Parameters:

level - Specifies the level of output ("verbose","normal","terse")

Returns:

message.

getMessage

public String getMessage()

returns the formatted message as a string

Returns:

text

printMessage

public void printMessage(PrintWriter writer)

prints message

Parameters:

writer - writer

printStackTrace

public void printStackTrace(PrintStream s)

override method

Parameters:

s - stream

printWithIndentation

public static void printWithIndentation(String prefix,
                        String msg,
                        PrintWriter writer)

write string to the writer

Parameters:

prefix - string

msg - string

writer - Print Writer

printStackTrace

public void printStackTrace(PrintWriter writer)

prints stacktrace

Parameters:

writer - writer

getStackTrace

public String getStackTrace()

stacktrace

Returns:

text

createJBIManagementMessage

public static JBIManagementMessage createJBIManagementMessage(String xmlText)

factory method to create the message object

Parameters:

xmlText - xml text

Returns:

Message Object

getL10NMessageType

protected static String getL10NMessageType(String msgType)

returns the l10n msgtyep string for msgType

Parameters:

msgType - is one of the INFO, ERROR, WARNING

Returns:

createJBIManagementMessage

public static JBIManagementMessage createJBIManagementMessage(String taskId,
                                              Map<String,String> responseMap,
                                              boolean requireAllSuccess)

Build a single management message from the entries in the map. Each entry in the map corresponds to a application variable name and the value is the JBI Management message ( or exception message ) response on the target.

Parameters:

taskId - - task id

responseMap - - a map of | application variable name | JBI Mgmt OR Exception message |

requireAllSuccess - boolean flag indicating that all responses need to be SUCCESS for the eventual task result to be SUCCESS.

Returns:

a single management message based on the entries in the map.