JBIResultXmlBuilder (jbi-admin-common 2.4.3 API)

java.lang.Object
- com.sun.jbi.ui.common.JBIResultXmlBuilder

```
public class JBIResultXmlBuilder
extends Object
```
This class is used to create a JBI Management message that contains the messages and exception under the framework tags to help the ui messages formatted in the standard message format as the any other result messages comming from the jbi runtime in the form of jbi manamgment message xml.

Author:

Sun Microsystems, Inc.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_MSG_CODE` default message code
`static String`	`DEFAULT_TASK_ID` default task id
`static String`	`ERROR_MSG_TYPE` error message type
`static boolean`	`FAILED_RESULT` failed result
`static String`	`INFO_MSG_TYPE` info message type
`static boolean`	`SUCCESS_RESULT` success result
`static String`	`WARNING_MSG_TYPE` warning message type

Constructor Summary

Constructors
Modifier Constructor and Description

protected JBIResultXmlBuilder()
Creates a new instance of EsbResultXmlBuilder

Constructors
Modifier	Constructor and Description
`protected`	`JBIResultXmlBuilder()` Creates a new instance of EsbResultXmlBuilder

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`createFailedJbiResultXml(I18NBundle i18nBundle, String i18nKey, Object[] args)` creates the jbi management xml
`static String`	`createJbiResultXml(I18NBundle i18nBundle, String i18nKey, Object[] args, String taskId, boolean successResult, String msgType, Throwable ex)` creates the jbi management xml
`static String`	`createJbiResultXml(I18NBundle i18nBundle, String i18nKey, Object[] args, Throwable ex)` creates the jbi management xml
`String`	`createJbiResultXml(JBIManagementMessage msg)` Creates a XML JBI Management message from the JBI Management Message
`String`	`createJbiResultXml(String taskId, boolean successResult, String msgType, String msgCode, String msg, Object[] args)` creates the jbi management xml
`String`	`createJbiResultXml(String taskId, boolean successResult, String msgType, String msgCode, String msg, Object[] args, Throwable ex)` creates the jbi management xml
`String`	`createJbiResultXml(String taskId, String msgCode, Throwable ex)` creates the jbi management xml
`protected List`	`flatExceptionChain(Throwable ex)` returns the exception cause chain in a list including this exception
`protected String`	`getChainedExceptionInfoXml(String msgCode, Throwable ex)` returns the xml chunk contains exception message info for the exception chain
`protected String`	`getExceptionInfoXml(String msgCode, int nestingLevel, Throwable ex)` returns exceptin info xml chunk
`protected String`	`getExceptionInfoXml(String msgCode, String locMsg, int nestingLevel, String stackTrace)` returns exceptin info xml chunk
`protected String`	`getExceptionStackTrace(Throwable ex)` return the excpetion stacktrace as a string
`static JBIResultXmlBuilder`	`getInstance()` returns the instance of this class
`protected String`	`getMsgLocInfoXml(String msgCode, String msg, Object[] args)` return the xml chunk contains the message info elements
`protected String`	`getTaskInfoXml(String taskId, boolean successResult, String msgType)` return the xml chunk that has task info elements
`protected String`	`getTaskStatusMsgXml(String msgCode, String msg, Object[] args)` return the xml chuck for status message elements

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- SUCCESS_RESULT
```
public static final boolean SUCCESS_RESULT
```
  success result
  
  See Also:
  Constant Field Values
- FAILED_RESULT
```
public static final boolean FAILED_RESULT
```
  failed result
  
  See Also:
  Constant Field Values
- INFO_MSG_TYPE
```
public static final String INFO_MSG_TYPE
```
  info message type
  
  See Also:
  Constant Field Values
- WARNING_MSG_TYPE
```
public static final String WARNING_MSG_TYPE
```
  warning message type
  
  See Also:
  Constant Field Values
- ERROR_MSG_TYPE
```
public static final String ERROR_MSG_TYPE
```
  error message type
  
  See Also:
  Constant Field Values
- DEFAULT_TASK_ID
```
public static final String DEFAULT_TASK_ID
```
  default task id
  
  See Also:
  Constant Field Values
- DEFAULT_MSG_CODE
```
public static final String DEFAULT_MSG_CODE
```
  default message code
  
  See Also:
  Constant Field Values

Constructor Detail
- JBIResultXmlBuilder
```
protected JBIResultXmlBuilder()
```
  Creates a new instance of EsbResultXmlBuilder

Method Detail

getInstance
```
public static JBIResultXmlBuilder getInstance()
```
returns the instance of this class

Returns:
instance of this class

flatExceptionChain
```
protected List flatExceptionChain(Throwable ex)
```
returns the exception cause chain in a list including this exception

Parameters:
ex - exception

Returns:
list contain the exception chain

getTaskInfoXml
```
protected String getTaskInfoXml(String taskId,
                    boolean successResult,
                    String msgType)
```
return the xml chunk that has task info elements

Parameters:
taskId - task id
successResult - true for SUCCESS, false for FAILED
msgType - one of INFO, ERROR, WARNING strings

Returns:
the xml chunk

getMsgLocInfoXml

protected String getMsgLocInfoXml(String msgCode,
                      String msg,
                      Object[] args)

return the xml chunk contains the message info elements

Parameters:: msgCode - i18n message code; msg - l10n message; args - arguments for i18n message
Returns:: the xml chunk

getTaskStatusMsgXml

protected String getTaskStatusMsgXml(String msgCode,
                         String msg,
                         Object[] args)

return the xml chuck for status message elements

Parameters:: msgCode - i18n message code; msg - l10n message; args - arguments for i18n message
Returns:: the xml chunk

getExceptionStackTrace
```
protected String getExceptionStackTrace(Throwable ex)
```
return the excpetion stacktrace as a string

Parameters:
ex - exception

Returns:
string contains the exception stacktrace

getExceptionInfoXml
```
protected String getExceptionInfoXml(String msgCode,
                         int nestingLevel,
                         Throwable ex)
```
returns exceptin info xml chunk

Parameters:
msgCode - i18n message code
nestingLevel - level in the exception chain
ex - exception for stacktrace

Returns:
xml chunk

getExceptionInfoXml

protected String getExceptionInfoXml(String msgCode,
                         String locMsg,
                         int nestingLevel,
                         String stackTrace)

returns exceptin info xml chunk

Parameters:: msgCode - i18n message code; locMsg - localized message; nestingLevel - level in the exception chain; stackTrace - stacktrace string
Returns:: xml chunk

getChainedExceptionInfoXml
```
protected String getChainedExceptionInfoXml(String msgCode,
                                Throwable ex)
```
returns the xml chunk contains exception message info for the exception chain

Parameters:
msgCode - i18n code
ex - exception

Returns:
xml chunk