org.jboss.soa.esb.actions.converters
Class ObjectToXStream

java.lang.Object
  extended by org.jboss.soa.esb.actions.converters.ObjectToXStream
All Implemented Interfaces:
ActionProcessor

public class ObjectToXStream
extends java.lang.Object
implements ActionProcessor

Object to XML processor.

Uses the XStream processor to generate an XML message String from the supplied object.

Sample Action Configuration:

 <Action name="Customer-To-XML" processor="ObjectToXStream">
     <property name="class-alias" value="Customer" /> <!-- Class alias used in call to XStream.alias(String, Class) prior to serialisation. -->
     <property name="exclude-package" value="false" /> <!-- Default "true".  Not applicable if a "class-alias" is specified. -->
 </Action>
 

The XML root element is either set from the "class-alias" property or the classes full name. In the later case, the class package is excluded unless "exclude-package" is set to "false"/"no".

Since:
Version 4.0
Author:
tom.fennelly@jboss.com

Constructor Summary
ObjectToXStream(java.lang.String actionName, java.util.List<KeyValuePair> properties)
          Public constructor.
 
Method Summary
 java.io.Serializable getErrorNotification(Message message)
          Get the "Error" notification message for this processor.
 java.io.Serializable getOkNotification(Message message)
          Get the "OK" notification message for this processor.
 Message process(Message message)
          Perform the processing action on the message
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ObjectToXStream

public ObjectToXStream(java.lang.String actionName,
                       java.util.List<KeyValuePair> properties)
Public constructor.

Parameters:
actionName - Action name.
properties - Action Properties.
Throws:
ConfigurationException - Action not properly configured.
Method Detail

process

public Message process(Message message)
                throws ActionProcessingException
Description copied from interface: ActionProcessor
Perform the processing action on the message

Specified by:
process in interface ActionProcessor
Parameters:
message - The message to be processed.
Returns:
Message - result of process
Throws:
ActionProcessingException - Exception during payload processing.

getOkNotification

public java.io.Serializable getOkNotification(Message message)
Description copied from interface: ActionProcessor
Get the "OK" notification message for this processor.

Specified by:
getOkNotification in interface ActionProcessor
Parameters:
message - The message Object.
Returns:
The OK message.

getErrorNotification

public java.io.Serializable getErrorNotification(Message message)
Description copied from interface: ActionProcessor
Get the "Error" notification message for this processor.

Specified by:
getErrorNotification in interface ActionProcessor
Parameters:
message - The message Object.
Returns:
The Error message.