org.ow2.petals.jbi.management.util
Class XMLResult

java.lang.Object
  org.ow2.petals.jbi.management.util.XMLResult

public class XMLResult
extends java.lang.Object

This class gathers the dtd used for the management message

Author:

ddesjardins - eBMWebsourcing, wjoseph - eBMWebsourcing

Nested Class Summary

static class	XMLResult.CauseFramework
static class	XMLResult.MessageType
static class	XMLResult.TaskResult

Field Summary

protected java.lang.String	frameworkTaskId
protected java.lang.StringBuffer	xmlBuffer

Constructor Summary

XMLResult(java.lang.String frameworkTaskId)

Method Summary

void	addComponentTaskResult(java.lang.StringBuffer componentTaskString) Added a component task result to this management message
void	addFrameworkTaskResult(XMLResult.TaskResult taskResult, XMLResult.CauseFramework causeFramework) Add a framework task result to a xml management message
void	addFrameworkTaskResult(XMLResult.TaskResult taskResult, XMLResult.MessageType messageType, java.lang.String message, java.lang.String[] messageParams, java.lang.String nestingLevel, java.lang.String exceptionMessage, java.lang.String[] exceptionMessageParams, java.lang.String stackStrace, XMLResult.CauseFramework causeFramework) Add a framework task result to a xml management message
void	addFrameworkTaskResult(XMLResult.TaskResult taskResult, XMLResult.MessageType messageType, java.lang.String message, java.lang.String[] messageParams, java.lang.String nestingLevel, java.lang.String exceptionMessage, java.lang.String[] exceptionMessageParams, XMLResult.CauseFramework causeFramework) Add a framework task result to a xml management message
void	addFrameworkTaskResult(XMLResult.TaskResult taskResult, XMLResult.MessageType messageType, java.lang.String message, java.lang.String[] messageParams, XMLResult.CauseFramework causeFramework) Add a framework task result to a xml management message
java.lang.String	getString() Close the XMLResult and return the String
static boolean	isValidComponentTask(java.lang.String componentTask, java.io.InputStream xsd) Check if a component task result is valid against a xml schema
static void	validateManagementMessage(java.lang.String managementMessage, java.io.InputStream xsd) Check if a management message task result is valid against a xml schema
java.lang.String	wrapComponentTaskResult(java.lang.String componentName, java.lang.String taskId, java.lang.String message) Return a component task result xml

Methods inherited from class java.lang.Object

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

Field Detail

xmlBuffer

protected java.lang.StringBuffer xmlBuffer

frameworkTaskId

protected java.lang.String frameworkTaskId

Constructor Detail

XMLResult

public XMLResult(java.lang.String frameworkTaskId)

Method Detail

addFrameworkTaskResult

public void addFrameworkTaskResult(XMLResult.TaskResult taskResult,
                                   XMLResult.CauseFramework causeFramework)

Add a framework task result to a xml management message

Parameters:

taskResult - result of the task

causeFramework - causeFramework

addFrameworkTaskResult

public void addFrameworkTaskResult(XMLResult.TaskResult taskResult,
                                   XMLResult.MessageType messageType,
                                   java.lang.String message,
                                   java.lang.String[] messageParams,
                                   XMLResult.CauseFramework causeFramework)

Add a framework task result to a xml management message

Parameters:

taskResult - result of the task

messageType - type of message

message - message

messageParams - list of param for the message

causeFramework - causeFramework

addFrameworkTaskResult

public void addFrameworkTaskResult(XMLResult.TaskResult taskResult,
                                   XMLResult.MessageType messageType,
                                   java.lang.String message,
                                   java.lang.String[] messageParams,
                                   java.lang.String nestingLevel,
                                   java.lang.String exceptionMessage,
                                   java.lang.String[] exceptionMessageParams,
                                   XMLResult.CauseFramework causeFramework)

Add a framework task result to a xml management message

Parameters:

taskResult - result of the task

messageType - type of message

message - message

messageParams - list of param for the message

nestingLevel - nesting level of the exception

exceptionMessage - message of the exception

exceptionMessageParams - list of the param for the exception message

causeFramework - causeFramework

addComponentTaskResult

public void addComponentTaskResult(java.lang.StringBuffer componentTaskString)

Added a component task result to this management message

Parameters:

componentTaskString - component task result xml

addFrameworkTaskResult

public void addFrameworkTaskResult(XMLResult.TaskResult taskResult,
                                   XMLResult.MessageType messageType,
                                   java.lang.String message,
                                   java.lang.String[] messageParams,
                                   java.lang.String nestingLevel,
                                   java.lang.String exceptionMessage,
                                   java.lang.String[] exceptionMessageParams,
                                   java.lang.String stackStrace,
                                   XMLResult.CauseFramework causeFramework)

Add a framework task result to a xml management message

Parameters:

taskResult - result of the task

messageType - type of message

message - message

messageParams - list of param for the message

nestingLevel - nesting level of the exception

exceptionMessage - message of the exception

exceptionMessageParams - list of the param for the exception message

stackStrace - stacktrace

causeFramework - causeFramework

getString

public java.lang.String getString()

Close the XMLResult and return the String

isValidComponentTask

public static boolean isValidComponentTask(java.lang.String componentTask,
                                           java.io.InputStream xsd)

Check if a component task result is valid against a xml schema

Parameters:

componentTask - xml of the component task

Returns:

true if valid, false if not valid

validateManagementMessage

public static void validateManagementMessage(java.lang.String managementMessage,
                                             java.io.InputStream xsd)
                                      throws java.lang.Exception

Check if a management message task result is valid against a xml schema

Parameters:

managementMessage - message xml of the management message

Throws:

java.lang.Exception

wrapComponentTaskResult

public java.lang.String wrapComponentTaskResult(java.lang.String componentName,
                                                java.lang.String taskId,
                                                java.lang.String message)

Return a component task result xml

Parameters:

componentName - component name

taskId - id of the task

taskResult - result of the task

messageType - type of message

message - message

messageParams - list of param for the message

nestingLevel - nesting level of the exception

exceptionMessage - message of the exception

exceptionMessageParams - list of the param for the exception message

stackStrace - stacktrace

Returns:

xml string