org.yawlfoundation.yawl.engine.interfce.interfaceX
Class InterfaceX_ServiceSideClient

java.lang.Object
  extended by org.yawlfoundation.yawl.engine.interfce.Interface_Client
      extended by org.yawlfoundation.yawl.engine.interfce.interfaceX.InterfaceX_ServiceSideClient

public class InterfaceX_ServiceSideClient
extends Interface_Client

InterfaceX_ServiceSideClient posts method calls from an exception service to the YAWL engine. This class is a member class of Interface X, which provides an interface between the YAWL Engine and a Custom YAWL Service that manages exception handling at the process level. InterfaceB_EnvironmentBasedClient was used as a template for this class. Schematic of Interface X: | EXCEPTION | INTERFACE X GATEWAY | SERVICE (implements) | | (implements) | | | | +==========+ -----> ENGINE-SIDE ---|--> SERVICE-SIDE -----> +=============+ || YAWL || CLIENT | SERVER || EXCEPTION || || ENGINE || | || SERVICE || +==========+ <----- ENGINE-SIDE <--|--- SERVICE-SIDE <----- +=============+ SERVER | CLIENT |

Version:
0.8, 04/07/2006
Author:
Michael Adams |

Constructor Summary
InterfaceX_ServiceSideClient(String backEndURIStr)
          Constructor.
 
Method Summary
 String addInterfaceXListener(String listenerURI)
           
 String cancelWorkItem(String workItemID, String data, boolean fail, String sessionHandle)
           
 WorkItemRecord continueWorkItem(String workItemID, String sessionHandle)
           
 void forceCompleteWorkItem(WorkItemRecord wir, org.jdom.Element data, String sessionHandle)
           
 String removeInterfaceXListener(String listenerURI)
           
 void restartWorkItem(String workItemID, String sessionHandle)
           
 void startWorkItem(String workItemID, String sessionHandle)
           
 WorkItemRecord unsuspendWorkItem(String workItemID, String sessionHandle)
           
 void updateCaseData(String caseID, org.jdom.Element data, String sessionHandle)
           
 void updateWorkItemData(WorkItemRecord wir, org.jdom.Element data, String sessionHandle)
           
 
Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client
executeGet, executePost, prepareParamMap, setReadTimeout, stripOuterElement, successful
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InterfaceX_ServiceSideClient

public InterfaceX_ServiceSideClient(String backEndURIStr)
Constructor.

Parameters:
backEndURIStr - the back end uri of where to find the engine. A default deployment this value is http://localhost:8080/yawl/ix
Method Detail

addInterfaceXListener

public String addInterfaceXListener(String listenerURI)
                             throws IOException
Throws:
IOException

removeInterfaceXListener

public String removeInterfaceXListener(String listenerURI)
                                throws IOException
Throws:
IOException

updateWorkItemData

public void updateWorkItemData(WorkItemRecord wir,
                               org.jdom.Element data,
                               String sessionHandle)
                        throws IOException
Throws:
IOException

updateCaseData

public void updateCaseData(String caseID,
                           org.jdom.Element data,
                           String sessionHandle)
                    throws IOException
Throws:
IOException

forceCompleteWorkItem

public void forceCompleteWorkItem(WorkItemRecord wir,
                                  org.jdom.Element data,
                                  String sessionHandle)
                           throws IOException
Throws:
IOException

continueWorkItem

public WorkItemRecord continueWorkItem(String workItemID,
                                       String sessionHandle)
                                throws IOException
Throws:
IOException

unsuspendWorkItem

public WorkItemRecord unsuspendWorkItem(String workItemID,
                                        String sessionHandle)
                                 throws IOException
Throws:
IOException

restartWorkItem

public void restartWorkItem(String workItemID,
                            String sessionHandle)
                     throws IOException
Throws:
IOException

startWorkItem

public void startWorkItem(String workItemID,
                          String sessionHandle)
                   throws IOException
Throws:
IOException

cancelWorkItem

public String cancelWorkItem(String workItemID,
                             String data,
                             boolean fail,
                             String sessionHandle)
                      throws IOException
Throws:
IOException


Copyright © 2004-2012 The YAWL Foundation.