com.sun.jbi.management.message

Class MessageBuilder

java.lang.Object

com.sun.jbi.management.message.MessageBuilder

public class MessageBuilder
extends Object

Helper class to create Management messages

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MessageBuilder.Message Message class encapsulates the JbiTask message, two accessors provide the message string and information on whether the message is a success or failure.
static class	MessageBuilder.MessageType
static class	MessageBuilder.TaskResult

Constructor Summary

Constructors

Constructor and Description
MessageBuilder(StringTranslator translator)

Method Summary

Methods

Modifier and Type	Method and Description
String	buildCompositeExceptionMessage(String taskId, Map<String,Throwable> exceptionMap) This method composes a JBI Task Message from the exceptions in the Map.
MessageBuilder.Message	buildCompositeMessage(String taskId, Map<String,String> responseMap, Map<String,Throwable> exceptionMap, boolean requireAllSuccess) This operation combines the data from exception jbi task messages and response jbi task messages.
String	buildExceptionMessage(String taskId, Throwable ex) Build a framework task message with exception.
String	buildFrameworkMessage(String taskId, MessageBuilder.TaskResult taskResult) Build a simple framework task message based on the passed parameters and return the string.
String	buildFrameworkMessage(String taskId, MessageBuilder.TaskResult taskResult, List<ComponentMessageHolder> compMsgs) Build a simple framework task message based on the passed parameters and return the string.
String	buildFrameworkMessage(String taskId, MessageBuilder.TaskResult taskResult, MessageBuilder.MessageType messageType, String message, String[] params, String token) Build a simple framework task message based on the passed parameters and return the string.
String	buildFrameworkMessage(String taskId, MessageBuilder.TaskResult taskResult, MessageBuilder.MessageType messageType, String message, String[] params, String token, List<ComponentMessageHolder> compMsgs) Build a Framework Message with component task results
MessageBuilder.Message	createMessage(String jbiTaskMsg) Create a message
static String	getMessageString(String message) Returns the string from a message entry without the JBIMAxxxx token.
static String	getMessageToken(String message) Returns the JBIMAxxxx mesage token from a localized message entry.
String	getStackTrace(Throwable exObj)
String	getString(JbiTaskResult jbiTaskMsg) Get the string from the management message object.
List<ServiceUnitInfo>	getSuccessfulServiceUnits(String jbiTaskMsg, List<ServiceUnitInfo> suInfoList) Parse the Component Results.
static boolean	isLocalizedMessage(String message)
static boolean	isXmlString(String str) This method is used to check if the given string contains well-formed XML.
void	throwManagementException(String taskId, String msgKey, String[] params)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBuilder

public MessageBuilder(StringTranslator translator)
               throws ManagementException

Throws:

ManagementException

Method Detail

createMessage

public MessageBuilder.Message createMessage(String jbiTaskMsg)
                                     throws ManagementException

Create a message

Parameters:

jbiTaskMsg - - task message string

Returns:

created Message

Throws:

ManagementException

buildFrameworkMessage

public String buildFrameworkMessage(String taskId,
                           MessageBuilder.TaskResult taskResult,
                           List<ComponentMessageHolder> compMsgs)
                             throws ManagementException

Build a simple framework task message based on the passed parameters and return the string.

Throws:

ManagementException

buildFrameworkMessage

public String buildFrameworkMessage(String taskId,
                           MessageBuilder.TaskResult taskResult)
                             throws ManagementException

Build a simple framework task message based on the passed parameters and return the string.

Throws:

ManagementException

buildFrameworkMessage

public String buildFrameworkMessage(String taskId,
                           MessageBuilder.TaskResult taskResult,
                           MessageBuilder.MessageType messageType,
                           String message,
                           String[] params,
                           String token,
                           List<ComponentMessageHolder> compMsgs)
                             throws ManagementException

Build a Framework Message with component task results

Throws:

ManagementException

buildFrameworkMessage

public String buildFrameworkMessage(String taskId,
                           MessageBuilder.TaskResult taskResult,
                           MessageBuilder.MessageType messageType,
                           String message,
                           String[] params,
                           String token)
                             throws ManagementException

Build a simple framework task message based on the passed parameters and return the string.

Throws:

ManagementException

buildExceptionMessage

public String buildExceptionMessage(String taskId,
                           Throwable ex)
                             throws ManagementException

Build a framework task message with exception. If the exception message is a jbi task message or a jbi localized message the message is returned as is.

Parameters:

taskId - - name of the operation which threw the exception

ex - - the exception

Throws:

ManagementException

getStackTrace

public String getStackTrace(Throwable exObj)

Returns:

the stack trace of the exception object as a string

getString

public String getString(JbiTaskResult jbiTaskMsg)
                 throws ManagementException

Get the string from the management message object.

Throws:

ManagementException

getMessageToken

public static String getMessageToken(String message)

Returns the JBIMAxxxx mesage token from a localized message entry.

getMessageString

public static String getMessageString(String message)

Returns the string from a message entry without the JBIMAxxxx token.

throwManagementException

public void throwManagementException(String taskId,
                            String msgKey,
                            String[] params)
                              throws ManagementException

Throws:

ManagementException

getSuccessfulServiceUnits

public List<ServiceUnitInfo> getSuccessfulServiceUnits(String jbiTaskMsg,
                                              List<ServiceUnitInfo> suInfoList)
                                                throws ManagementException

Parse the Component Results. This is based on the fact that the ServiceUnitList obtained from a ServiceAssemblyInfo and the ComponentTaskResults follow the document order of the ServiceUnits in the Service Assembly jbi.xml. The DeploymentService should also append a ComponentTaskResult for each Service Unit in the Service Assembly.

Throws:

ManagementException

buildCompositeExceptionMessage

public String buildCompositeExceptionMessage(String taskId,
                                    Map<String,Throwable> exceptionMap)
                                      throws ManagementException

This method composes a JBI Task Message from the exceptions in the Map. In cases of complete failure what we get back from the remote instance is an exception, which ( hopefully ) has a jbi task message as the message. If the exceptions message is not a jbi task message, then this will build a jbi task message from it. This composition is required only in the complete failure cases.

Parameters:

exceptionMap - - a map keyed by the instance names and the value is the exception thrown by the remote instance with the MBean exceptions stripped off.

Returns:

a composite JBI Task message that has all the information.

Throws:

ManagementException

buildCompositeMessage

public MessageBuilder.Message buildCompositeMessage(String taskId,
                                           Map<String,String> responseMap,
                                           Map<String,Throwable> exceptionMap,
                                           boolean requireAllSuccess)
                                             throws ManagementException

This operation combines the data from exception jbi task messages and response jbi task messages. The primary user of this operation is the facade DeploymentSvc.

Parameters:

taskId - - task id

responseMap - - a map of jbi task message responses from instances.

exceptionMap - - a map of exception task message from instances.

requireAllSuccess - - this flag indicates how the result of component task results for each component from various instances has to be handled. If set to true a Component task result has a task result of SUCCESS only if all the ComponentTask results in the response and exception maps are a success.

Throws:

ManagementException

isXmlString

public static boolean isXmlString(String str)

This method is used to check if the given string contains well-formed XML.

Parameters:

str - the string

Returns:

true if the given string is xml

isLocalizedMessage

public static boolean isLocalizedMessage(String message)

Returns:

true if the message starts with JBIMA