com.sun.jbi.management

Class ComponentMessageHolder

java.lang.Object

com.sun.jbi.management.ComponentMessageHolder

public class ComponentMessageHolder
extends Object

This provides necessary methods for the components to pass the task result data to ManagemntMessageBuilder. ManagementMessageBuilder constructs an XML document based on this.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
ComponentMessageHolder(String msgType) Creates a new instance of MessageContentHolder with a message type.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentMessageType() Get the type(status, exception) of message to be built for this component.
String	getComponentName() Return the name of the component.
String	getExceptionMessageType() Get the exception message type being returned by the component.
Throwable	getExceptionObject() Get the exception object being thrown by this component.
String	getLocMessage(int nestingLevel) Returns the exception message.
String[]	getLocParam(int nestingLevel) Returns the exception message parameters.
String	getLocToken(int nestingLevel) Returns the message token.
String	getStatusMessageType() Get the status message type being returned by the component.
String	getTaskName() Get the name of the task executed by this component.
String	getTaskResult() Get the result of the task executed by this component.
void	setComponentName(String name) Set the name of the component that executed the task.
void	setExceptionMessageType(String exMsgType) Set the exception message type being returned by the component.
void	setExceptionObject(Throwable exObj) Set the exception object.
void	setLocMessage(int nestingLevel, String locMessage) Set the message for the exception being thrown by the component.
void	setLocParam(int nestingLevel, String[] locParam) Set the message parameters for the exception being thrown by the component.
void	setLocToken(int nestingLevel, String locToken) Set the message token for the exception being thrown by the component.
void	setStatusMessageType(String statMsgType) Set the message type being returned by the component.
void	setTaskName(String taskName) Set the name of the task executed by component.
void	setTaskResult(String taskResult) Set the result of the task executed by component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentMessageHolder

public ComponentMessageHolder(String msgType)

Creates a new instance of MessageContentHolder with a message type.

Parameters:

msgType - String describing the message type to build.

Method Detail

setTaskName

public void setTaskName(String taskName)

Set the name of the task executed by component.

Parameters:

taskName - - task executed by component.

setComponentName

public void setComponentName(String name)

Set the name of the component that executed the task.

Parameters:

name - - Name of the component.

setTaskResult

public void setTaskResult(String taskResult)

Set the result of the task executed by component.

Parameters:

taskResult - - result of task executed by component.

setExceptionObject

public void setExceptionObject(Throwable exObj)

Set the exception object.

Parameters:

exObj - - exception object.

setStatusMessageType

public void setStatusMessageType(String statMsgType)

Set the message type being returned by the component.

Parameters:

statMsgType - - type of success message that is being returned by the component.

setExceptionMessageType

public void setExceptionMessageType(String exMsgType)

Set the exception message type being returned by the component.

Parameters:

exMsgType - - type of exception message that is being returned by the component.

setLocToken

public void setLocToken(int nestingLevel,
               String locToken)

Set the message token for the exception being thrown by the component.

Parameters:

nestingLevel - - nesting level of the exception

locToken - - message token.

setLocMessage

public void setLocMessage(int nestingLevel,
                 String locMessage)

Set the message for the exception being thrown by the component.

Parameters:

nestingLevel - - nesting level of the exception.

locMessage - - exception message.

setLocParam

public void setLocParam(int nestingLevel,
               String[] locParam)

Set the message parameters for the exception being thrown by the component.

Parameters:

nestingLevel - - nesting level of the exception.

locParam - - exception message parameters.

getLocToken

public String getLocToken(int nestingLevel)

Returns the message token.

Parameters:

nestingLevel - nesting level of the exception.

Returns:

message token at the given nesting level.

getLocMessage

public String getLocMessage(int nestingLevel)

Returns the exception message.

Parameters:

nestingLevel - nesting level of the exception

Returns:

exception message at the given nesting level

getLocParam

public String[] getLocParam(int nestingLevel)

Returns the exception message parameters.

Parameters:

nestingLevel - nesting level of the exception.

Returns:

exception message parameters at the given nesting level.

getExceptionObject

public Throwable getExceptionObject()

Get the exception object being thrown by this component.

Returns:

Exception Object.

getTaskName

public String getTaskName()

Get the name of the task executed by this component.

Returns:

Task name.

getTaskResult

public String getTaskResult()

Get the result of the task executed by this component.

Returns:

Task Result.

getComponentMessageType

public String getComponentMessageType()

Get the type(status, exception) of message to be built for this component.

Returns:

Task Result.

getStatusMessageType

public String getStatusMessageType()

Get the status message type being returned by the component.

Returns:

Status message type.

getExceptionMessageType

public String getExceptionMessageType()

Get the exception message type being returned by the component.

Returns:

Status message type.

getComponentName

public String getComponentName()

Return the name of the component.

Returns:

component name.