com.ibm.bpe.api

Class ProcessResponseWrapper

  1. java.lang.Object
  2. extended bycom.ibm.bpe.api.ProcessResponseWrapper
All implemented interfaces:
java.io.Serializable

  1. public final class ProcessResponseWrapper
  2. extends java.lang.Object
  3. implements java.io.Serializable
Wraps the output message returned by a microflow and its associated custom client settings.

The ProcessResponseWrapper class servers two major purposes:

Since:
5.1
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Constructor Summary

Constructor and Description
ProcessResponseWrapper()
Default constructor needed by deserialization.
ProcessResponseWrapper(java.lang.Object message,CustomClientSettings setting)
Constructor that stores the passed objects.

Method Summary

Modifier and Type Method and Description
  1. static
  2. ProcessResponseWrapper
fromByteArray(byte[] buffer,CustomClientSettings setting)
Factory method that creates a ProcessResponseWrapper from a byte array and custom client setting.
  1. CustomClientSettings
getClientUISettings()
Returns the custom client settings associated to the message.
  1. java.lang.Object
getMessage()
Returns the wrapped object, the message.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
See Also:

Constructor Detail

ProcessResponseWrapper

  1. public ProcessResponseWrapper()
Default constructor needed by deserialization. Sets the wrapped object to null.

ProcessResponseWrapper

  1. public ProcessResponseWrapper(java.lang.Object message,
  2. CustomClientSettings setting)
Constructor that stores the passed objects.
Parameters:
message - The message to be returned. The message must implement java.io.Serializable.
setting - The custom client settings associated with the message.

Method Detail

fromByteArray

  1. public static ProcessResponseWrapper fromByteArray( byte[] buffer,
  2. CustomClientSettings setting)
Factory method that creates a ProcessResponseWrapper from a byte array and custom client setting. The constructor taking a byte array as parameter is private because it is ambiguous (arrays are also objects).
Parameters:
buffer - The serialized message to wrap.
setting - The custom client settings associated with the message.
Returns:
A ProcessResponseWrapper object.

getMessage

  1. public java.lang.Object getMessage( )
  2. throws ProcessException
Returns the wrapped object, the message.

If the ProcessResponseWrapper has been serialized, then deserialized and this is the first time the message is accessed, the message is deserialized before it is returned. If the ProcessResponseWrapper has never been serialized, or the message has been accessed before, the message is returned without deserialization.

Returns:
The message contained in the ProcessResponseWrapper object.
Throws:
ProcessException - if an error occurrs during deserialization of the message.

getClientUISettings

  1. public CustomClientSettings getClientUISettings( )
Returns the custom client settings associated to the message.

Returns:
The custom client settings.