com.sun.jbi.management.system

Class BuildManagementMessageImpl

java.lang.Object

com.sun.jbi.management.system.BuildManagementMessageImpl

All Implemented Interfaces:

ManagementMessageBuilder

public class BuildManagementMessageImpl
extends Object
implements ManagementMessageBuilder

BuildManagementMessageImpl provides utility methods to build messages (as XML string) that are returned to the clients by the JBI Framework.

Constructor Summary

Constructors

Constructor and Description
BuildManagementMessageImpl() Constructs a BuildManagementMessageImpl.

Method Summary

Methods

Modifier and Type	Method and Description
String	buildCompleteExceptionMessage(ManagementMessageHolder mmObj) Constructs an XML string of the framework exception.
String	buildComponentMessage(ComponentMessageHolder cmObj) Return an XML string of the task result(either status of exception).
String	buildComponentTaskExceptionMessage(ComponentMessageHolder mmObj) Constructs an XML string of the component exception.
String	buildComponentTaskStatusMessage(ComponentMessageHolder mmObj) Return an XML string of the task status.
Element	buildExceptionXMLFragment(Document doc, ComponentMessageHolder mmObj)
Element	buildFrameworkExceptionMessage(Document doc, ManagementMessageHolder mmObj) Constructs an XML string of the framework exception.
Element	buildFrameworkTaskStatusMessage(Document doc, ManagementMessageHolder mmObj) Return an XML string of the task status.
String	buildJbiTask(ManagementMessageHolder mmObj) Constructs an XML string of the framework exception.
Document	createDocument() Returns a org.w3c.dom.Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildManagementMessageImpl

public BuildManagementMessageImpl()

Constructs a BuildManagementMessageImpl.

Method Detail

buildComponentMessage

public String buildComponentMessage(ComponentMessageHolder cmObj)
                             throws Exception

Return an XML string of the task result(either status of exception). This is the task executed by the component

Specified by:

buildComponentMessage in interface ManagementMessageBuilder

Parameters:

params - Status details of the component

Returns:

XML string with task status

Throws:

Exception - If fails to build XML string

buildComponentTaskStatusMessage

public String buildComponentTaskStatusMessage(ComponentMessageHolder mmObj)
                                       throws Exception

Return an XML string of the task status. This is the task executed by the component

Parameters:

params - Status details of the component

Returns:

XML string with task status

Throws:

Exception - If fails to build XML string

buildFrameworkTaskStatusMessage

public Element buildFrameworkTaskStatusMessage(Document doc,
                                      ManagementMessageHolder mmObj)
                                        throws Exception

Return an XML string of the task status. This is the task executed by the framework

Parameters:

doc - XML document which needs to be built

taskName - name of the task

taskResult - Status of the task

frameworkLocale - Locale in which the framework is running

Returns:

Element with framework task status

Throws:

Exception - If fails to build framework task status

buildExceptionXMLFragment

public Element buildExceptionXMLFragment(Document doc,
                                ComponentMessageHolder mmObj)
                                  throws Exception

Throws:

Exception

buildComponentTaskExceptionMessage

public String buildComponentTaskExceptionMessage(ComponentMessageHolder mmObj)
                                          throws Exception

Constructs an XML string of the component exception.

Parameters:

params - HashMap containing component exception information

Returns:

XML string representing component exception

Throws:

Exception - If fails to build component exception message

buildFrameworkExceptionMessage

public Element buildFrameworkExceptionMessage(Document doc,
                                     ManagementMessageHolder mmObj)
                                       throws Exception

Constructs an XML string of the framework exception.

Parameters:

doc - Document that needs to be built

params - HashMap containing component exception information

Returns:

XML string representing framework exception

Throws:

Exception - If fails to build framework exception message

createDocument

public Document createDocument()
                        throws Exception

Returns a org.w3c.dom.Element.

Returns:

org.w3c.dom.Document

Throws:

Exception - If fails to build Document

buildCompleteExceptionMessage

public String buildCompleteExceptionMessage(ManagementMessageHolder mmObj)

Constructs an XML string of the framework exception.

Parameters:

taskName - name of the task

stckTrElem - Array of StackTraceElements

jbiExLocToken - Error message token

jbiExLocMessage - Framework error message

Returns:

XML string representing framework exception message

buildJbiTask

public String buildJbiTask(ManagementMessageHolder mmObj)

Constructs an XML string of the framework exception.

Parameters:

params - HashMap containing framework exception information

Returns:

XML string representing framework exception