org.yawlfoundation.yawl.smsModule

Class SMSSender

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

org.yawlfoundation.yawl.smsModule.SMSSender

All Implemented Interfaces:

java.lang.Runnable

public class SMSSender
extends InterfaceBWebsideController
implements java.lang.Runnable

Author:

Lachlan Aldred Date: 4/03/2005 Time: 11:48:29

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_receiveURI
static java.lang.String	_sendURI

Fields inherited from class org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

_ibCache, _interfaceBClient, _logger, _report, engineLogonName, engineLogonPassword, XSD_ANYURI_TYPE, XSD_NAMESPACE, XSD_NCNAME_TYPE, XSD_STRINGTYPE

Constructor Summary

Constructors

Constructor and Description
SMSSender()

Method Summary

Modifier and Type	Method and Description
YParameter[]	describeRequiredParams() Override this method if you wish to allow other tools to find out what input parameters are required for your custom YAWL service to work.
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override this method to provide a welcome screen for your Custom YAWL Service For instance you could redirect to a JSP or just write typical servlet doGet() code inside your subclass.
java.util.List	getCompletedInteractions()
void	handleCancelledWorkItemEvent(WorkItemRecord workItemRecord) By implementing this method and deploying a web app containing the implementation the YAWL engine will send events to this method notifying your custom YAWL service that an active work item has been cancelled by the engine.
void	handleEnabledWorkItemEvent(WorkItemRecord enabledWorkItem) Checks the work item out of the engine, sends an sms message, and starts the thread that checks for a reply.
static void	main(java.lang.String[] args)
void	run()
void	setSMSUsernameAndPassword(java.lang.String username, java.lang.String password)

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

checkConnection, checkInWorkItem, checkInWorkItem, checkInWorkItem, checkOut, checkOutAllInstancesOfThisTask, connect, destroy, getAuthenticationConfig, getCachedWorkItem, getChildren, getEngineStoredWorkItem, getIBCache, getModel, getResourcingSpecs, getSpecificationData, getSpecificationData, getSpecificationPrototypesList, getTaskInformation, getTaskInformation, handleCancelledCaseEvent, handleCaseResumedEvent, handleCaseSuspendedEvent, handleCaseSuspendingEvent, handleCompleteCaseEvent, handleDeadlockedCaseEvent, handleEngineInitialisationCompletedEvent, handleStartCaseEvent, handleTimerExpiryEvent, handleWorkItemStatusChangeEvent, logContactError, prepareReplyRootElement, setEngineLogonName, setEngineLogonPassword, setRemoteAuthenticationDetails, setUpInterfaceBClient, successful

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_sendURI

public static java.lang.String _sendURI

_receiveURI

public static java.lang.String _receiveURI

Constructor Detail

SMSSender

public SMSSender()

Method Detail

handleEnabledWorkItemEvent

public void handleEnabledWorkItemEvent(WorkItemRecord enabledWorkItem)

Checks the work item out of the engine, sends an sms message, and starts the thread that checks for a reply.

Specified by:

handleEnabledWorkItemEvent in class InterfaceBWebsideController

Parameters:

enabledWorkItem -

describeRequiredParams

public YParameter[] describeRequiredParams()

Description copied from class: InterfaceBWebsideController

Override this method if you wish to allow other tools to find out what input parameters are required for your custom YAWL service to work.

Overrides:

describeRequiredParams in class InterfaceBWebsideController

Returns:

an array of input parameters.

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws javax.servlet.ServletException,
                  java.io.IOException

Description copied from class: InterfaceBWebsideController

Override this method to provide a welcome screen for your Custom YAWL Service For instance you could redirect to a JSP or just write typical servlet doGet() code inside your subclass.

Overrides:

doGet in class InterfaceBWebsideController

Parameters:

req - the request

resp - the response.

Throws:

javax.servlet.ServletException - if the request for the GET could not be handled

java.io.IOException - if an error is detected when the servlet handles the GET request

handleCancelledWorkItemEvent

public void handleCancelledWorkItemEvent(WorkItemRecord workItemRecord)

By implementing this method and deploying a web app containing the implementation the YAWL engine will send events to this method notifying your custom YAWL service that an active work item has been cancelled by the engine.

Specified by:

handleCancelledWorkItemEvent in class InterfaceBWebsideController

Parameters:

workItemRecord - a "snapshot" of the work item cancelled in the engine.

main

public static void main(java.lang.String[] args)
                 throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

run

public void run()

Specified by:

run in interface java.lang.Runnable

setSMSUsernameAndPassword

public void setSMSUsernameAndPassword(java.lang.String username,
                                      java.lang.String password)

getCompletedInteractions

public java.util.List getCompletedInteractions()