SMILA (incubation) API documentation

org.eclipse.smila.processing.bpel
Class MessageHelper

java.lang.Object
  extended by org.eclipse.smila.processing.bpel.MessageHelper

public final class MessageHelper
extends java.lang.Object

Utility class to create and parse the DOM XML messages which we use to talk to the ODE engine, and sync workflow objects to the blackboard.

Author:
jschumacher

Constructor Summary
MessageHelper(java.util.Properties properties)
          create instance.
 
Method Summary
 void addRequestId(org.w3c.dom.Element message, java.lang.String requestId, javax.xml.namespace.QName varType)
          add request id part as first child element of message.
 org.w3c.dom.Element createMessage(Blackboard blackboard, java.lang.String[] recordIds)
          create workflow objects for specified IDs, create DOM representations of this record list and embed it as BPEL message.
 java.lang.String[] parseMessage(Blackboard blackboard, org.w3c.dom.Element message)
          sync workflow objects from DOM message to blackboard and return IDs of workflow objects.
 java.lang.String parseRequestId(org.w3c.dom.Element message)
          read request Id from message variable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageHelper

public MessageHelper(java.util.Properties properties)
create instance.

Parameters:
properties - configuration properties
Method Detail

parseRequestId

public java.lang.String parseRequestId(org.w3c.dom.Element message)
read request Id from message variable.

Parameters:
message - variable value
Returns:
request Id

parseMessage

public java.lang.String[] parseMessage(Blackboard blackboard,
                                       org.w3c.dom.Element message)
sync workflow objects from DOM message to blackboard and return IDs of workflow objects.

Parameters:
blackboard - to sync workflow objects to.
message - DOM message from BPEL engine containing workflow objects.
Returns:
IDs of workflow objects in message

createMessage

public org.w3c.dom.Element createMessage(Blackboard blackboard,
                                         java.lang.String[] recordIds)
                                  throws ProcessingException
create workflow objects for specified IDs, create DOM representations of this record list and embed it as BPEL message. This is done by appending them to <message><records> elements.

Parameters:
blackboard - blackboard to read records from.
recordIds - IDs of workflow objects in message
Returns:
DOM representation of workflow objects
Throws:
ProcessingException - error creating workflow record.

addRequestId

public void addRequestId(org.w3c.dom.Element message,
                         java.lang.String requestId,
                         javax.xml.namespace.QName varType)
add request id part as first child element of message.

Parameters:
message - a message variable
requestId - request id.
varType - type of variable. currently necessary to decide where to put the Id.

SMILA (incubation) API documentation