org.yawlfoundation.yawl.cost.interfce

Class CostGatewayClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.cost.interfce.CostGatewayClient

Direct Known Subclasses:

CostClient

public class CostGatewayClient
extends Interface_Client

An API to be used by clients that want to retrieve data from the cost service.

Author:

Michael Adams 11/07/2011

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_costURI the uri of the YAWL Cost Service a default would be "http://localhost:8080/costService/gateway"

Constructor Summary

Constructors

Constructor and Description
CostGatewayClient()
CostGatewayClient(java.lang.String uri) the constructors

Method Summary

Modifier and Type	Method and Description
double	calculate(YSpecificationID specID, java.lang.String caseID, java.lang.String predicate, java.lang.String handle)
java.lang.String	checkConnection(java.lang.String handle) Check that a session handle is active
java.lang.String	clearModels(YSpecificationID specID, java.lang.String handle) Clears all the cost model for a particular specification from the service
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the cost service
void	disconnect(java.lang.String handle) Disconnects an external entity from the cost service
boolean	evaluate(YSpecificationID specID, java.lang.String caseID, java.lang.String predicate, java.lang.String handle)
java.lang.String	exportModel(YSpecificationID specID, java.lang.String modelID, java.lang.String handle) Gets a cost model from the service
java.lang.String	exportModels(YSpecificationID specID, java.lang.String handle) Gets the cost models for a specification from the service
java.lang.String	getAnnotatedLog(YSpecificationID specID, boolean withData, java.lang.String handle)
java.lang.String	getFixedCosts(YSpecificationID specID, java.lang.String taskName, java.lang.String handle) Gets an XML list of all the fixed costs for the specified specification - task combination.
java.lang.String	getFunctionList(YSpecificationID specID, java.lang.String taskName, java.lang.String handle) Gets an XML list of all cost functions for the specified specification - task combination.
java.lang.String	getResourceCosts(YSpecificationID specID, java.lang.String taskName, java.util.Set<java.lang.String> resources, java.lang.String handle)
java.lang.String	getResourceCosts(YSpecificationID specID, java.lang.String taskName, java.lang.String resources, java.lang.String handle) Gets the cost of performing an activity for each resource in a Set.
java.lang.String	importModel(java.lang.String modelXML, java.lang.String handle) Loads a cost model into the service
java.lang.String	importModels(java.lang.String modelsXML, java.lang.String handle) Loads a number of cost models into the service
java.lang.String	removeModel(YSpecificationID specID, java.lang.String modelID, java.lang.String handle) Removes a cost model from the service
void	setURI(java.lang.String uri)

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

Methods inherited from class java.lang.Object

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

Field Detail

_costURI

protected java.lang.String _costURI

the uri of the YAWL Cost Service a default would be "http://localhost:8080/costService/gateway"

Constructor Detail

CostGatewayClient

public CostGatewayClient(java.lang.String uri)

the constructors

Parameters:

uri - the uri of the YAWL Cost Service

CostGatewayClient

public CostGatewayClient()

Method Detail

setURI

public void setURI(java.lang.String uri)

connect

public java.lang.String connect(java.lang.String userID,
                                java.lang.String password)
                         throws java.io.IOException

Connects an external entity to the cost service

Parameters:

userID - the userid

password - the corresponding password

Returns:

a sessionHandle if successful, or a failure message if not

Throws:

java.io.IOException - if the service can't be reached

checkConnection

public java.lang.String checkConnection(java.lang.String handle)
                                 throws java.io.IOException

Check that a session handle is active

Parameters:

handle - the session handle to check

Returns:

"true" if the id is valid, "false" if otherwise

Throws:

java.io.IOException - if the service can't be reached

disconnect

public void disconnect(java.lang.String handle)
                throws java.io.IOException

Disconnects an external entity from the cost service

Parameters:

handle - the sessionHandle to disconnect

Throws:

java.io.IOException - if the service can't be reached

importModel

public java.lang.String importModel(java.lang.String modelXML,
                                    java.lang.String handle)
                             throws java.io.IOException

Loads a cost model into the service

Parameters:

modelXML - the model to import

handle - a current sessionHandle to the cost service

Returns:

a success or error message

Throws:

java.io.IOException

importModels

public java.lang.String importModels(java.lang.String modelsXML,
                                     java.lang.String handle)
                              throws java.io.IOException

Loads a number of cost models into the service

Parameters:

modelsXML - the set of models to import, represented as an set of valid cost mode XML child elements contained within an outer element called 'costmodels'

handle - a current sessionHandle to the cost service

Returns:

a success or error message

Throws:

java.io.IOException

exportModels

public java.lang.String exportModels(YSpecificationID specID,
                                     java.lang.String handle)
                              throws java.io.IOException

Gets the cost models for a specification from the service

Parameters:

specID - the id of the specification to get the models for

handle - a current sessionHandle to the cost service

Returns:

a String XML representation of the models if successful or an error message if not

Throws:

java.io.IOException

exportModel

public java.lang.String exportModel(YSpecificationID specID,
                                    java.lang.String modelID,
                                    java.lang.String handle)
                             throws java.io.IOException

Gets a cost model from the service

Parameters:

specID - the id of the specification to get the model for

modelID - the id of the model to get

handle - a current sessionHandle to the cost service

Returns:

a String XML representation of the model if successful or an error message if not

Throws:

java.io.IOException

removeModel

public java.lang.String removeModel(YSpecificationID specID,
                                    java.lang.String modelID,
                                    java.lang.String handle)
                             throws java.io.IOException

Removes a cost model from the service

Parameters:

specID - the id of the specification to remove the model for

modelID - the id of the model to remove

handle - a current sessionHandle to the cost service

Returns:

an XML success or error message

Throws:

java.io.IOException

clearModels

public java.lang.String clearModels(YSpecificationID specID,
                                    java.lang.String handle)
                             throws java.io.IOException

Clears all the cost model for a particular specification from the service

Parameters:

specID - the id of the specification to remove the models for

handle - a current sessionHandle to the cost service

Returns:

an XML success or error message

Throws:

java.io.IOException

getAnnotatedLog

public java.lang.String getAnnotatedLog(YSpecificationID specID,
                                        boolean withData,
                                        java.lang.String handle)
                                 throws java.io.IOException

Parameters:

specID -

withData -

handle - a current sessionhandle to the cost service

Returns:

Throws:

java.io.IOException

evaluate

public boolean evaluate(YSpecificationID specID,
                        java.lang.String caseID,
                        java.lang.String predicate,
                        java.lang.String handle)
                 throws java.io.IOException

Throws:

java.io.IOException

calculate

public double calculate(YSpecificationID specID,
                        java.lang.String caseID,
                        java.lang.String predicate,
                        java.lang.String handle)
                 throws java.io.IOException

Throws:

java.io.IOException

getFunctionList

public java.lang.String getFunctionList(YSpecificationID specID,
                                        java.lang.String taskName,
                                        java.lang.String handle)
                                 throws java.io.IOException

Gets an XML list of all cost functions for the specified specification - task combination.

Parameters:

specID - the specification identifier

taskName - the task identifier (may be null, in which case only the case level functions are required)

handle - a current sessionhandle to the cost service

Returns:

an XML list of the cost functions requested, or an appropriate failure message.

Throws:

java.io.IOException - if there's a problem connecting to the service

getFixedCosts

public java.lang.String getFixedCosts(YSpecificationID specID,
                                      java.lang.String taskName,
                                      java.lang.String handle)
                               throws java.io.IOException

Gets an XML list of all the fixed costs for the specified specification - task combination.

Parameters:

specID - the specification identifier

taskName - the task identifier (may be null, in which case only the case level costs are required)

handle - a current sessionhandle to the cost service

Returns:

an XML list of the costs requested, or an appropriate failure message.

Throws:

java.io.IOException - if there's a problem connecting to the service

getResourceCosts

public java.lang.String getResourceCosts(YSpecificationID specID,
                                         java.lang.String taskName,
                                         java.lang.String resources,
                                         java.lang.String handle)
                                  throws java.io.IOException

Gets the cost of performing an activity for each resource in a Set.

Parameters:

specID - the specification identifier

taskName - the task name (may be null, in which case only the case level costs are required)

resources - an XML document containing participant ids

handle - a current sessionhandle to the cost service

Returns:

an XML document containing the actual result of applying the costParams to the relevant cost functions.

Throws:

java.io.IOException - if there's a problem connecting to the service

getResourceCosts

public java.lang.String getResourceCosts(YSpecificationID specID,
                                         java.lang.String taskName,
                                         java.util.Set<java.lang.String> resources,
                                         java.lang.String handle)
                                  throws java.io.IOException

Parameters:

specID - the specification identifier

taskName - the task name

resources - the set of participant ids to get costs for

handle - a current sessionhandle to the cost service

Returns:

Throws:

java.io.IOException