org.yawlfoundation.yawl.engine.interfce.interfaceA

Class InterfaceA_EnvironmentBasedClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.engine.interfce.interfaceA.InterfaceA_EnvironmentBasedClient

public class InterfaceA_EnvironmentBasedClient
extends Interface_Client

/** A client side API for the management of processes, services and users

Author:

Lachlan Aldred Date: 16/04/2004 Time: 16:15:02, Michael Adams (refactored for v2.0, 06/2008, and v2.1 11/2009)

Constructor Summary

Constructors

Constructor and Description
InterfaceA_EnvironmentBasedClient(java.lang.String backEndURIStr) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	addClientAccount(java.lang.String name, java.lang.String password, java.lang.String documentation, java.lang.String sessionHandle) Creates a new user inside the engine.
java.lang.String	addClientAccount(YExternalClient client, java.lang.String sessionHandle)
java.lang.String	addYAWLService(YAWLServiceReference service, java.lang.String sessionHandle) Registers a new custom YAWL service woth the engine.
java.lang.String	changePassword(java.lang.String password, java.lang.String sessionHandle) Change the password of a service or client account on the engine, the account being the owner of the session handle.
java.lang.String	checkConnection(java.lang.String sessionHandle) Checks that a session handle is active
java.lang.String	connect(java.lang.String userID, java.lang.String password) Creates a user session with the engine.
java.lang.String	demote(java.lang.String sessionHandle)
java.lang.String	disconnect(java.lang.String handle) Disconnects an external entity from the engine
java.lang.String	getBackEndURI()
java.lang.String	getBuildProperties(java.lang.String sessionHandle)
YExternalClient	getClientAccount(java.lang.String userID, java.lang.String sessionHandle)
java.util.Set<YExternalClient>	getClientAccounts(java.lang.String sessionHandle) Gets all the client accounts registered in the engine
java.lang.String	getExternalDBGateways(java.lang.String sessionHandle)
java.lang.String	getHibernateStatistics(java.lang.String sessionHandle)
java.lang.String	getPassword(java.lang.String userid, java.lang.String sessionHandle)
java.util.Set<YAWLServiceReference>	getRegisteredYAWLServices(java.lang.String sessionHandle) Returns a list of YAWL service objects registered with the engine.
java.lang.String	getRegisteredYAWLServicesAsXML(java.lang.String sessionHandle) Returns an XML string list of YAWL services registered with the engine.
YAWLServiceReference	getYAWLService(java.lang.String serviceURI, java.lang.String sessionHandle)
java.lang.String	isHibernateStatisticsEnabled(java.lang.String sessionHandle)
java.lang.String	promote(java.lang.String sessionHandle)
java.lang.String	removeClientAccount(java.lang.String name, java.lang.String sessionHandle) Delete an external client account PREcondition: cannot delete self
java.lang.String	removeYAWLService(java.lang.String serviceURI, java.lang.String sessionHandle) Removes a YAWL service from the engine.
java.lang.String	setHibernateStatisticsEnabled(boolean enabled, java.lang.String sessionHandle)
java.lang.String	unloadSpecification(java.lang.String specID, java.lang.String sessionHandle) Deprecated. superceded by unloadSpecification(YSpecificationID, String) - this version is appropriate for pre-2.0 schema-based specs only
java.lang.String	unloadSpecification(YSpecificationID specID, java.lang.String sessionHandle) Unloads a loaded specification from the engine
java.lang.String	updateClientAccount(java.lang.String name, java.lang.String password, java.lang.String documentation, java.lang.String sessionHandle)
java.lang.String	uploadSpecification(java.io.File file, java.lang.String sessionHandle) Uploads a specification into the engine.
java.lang.String	uploadSpecification(java.lang.String specification, java.lang.String sessionHandle) Uploads a specification into the engine.
java.lang.String	uploadSpecification(java.lang.String specification, java.lang.String filename, java.lang.String sessionHandle) Deprecated. use uploadSpecification(String, String) instead (since 2.0)

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

Constructor Detail

InterfaceA_EnvironmentBasedClient

public InterfaceA_EnvironmentBasedClient(java.lang.String backEndURIStr)

Constructor

Parameters:

backEndURIStr - the back end uri of where to find the engine. In a default deployment, this value is "http://localhost:8080/yawl/ia" but it can be changed.

Method Detail

getBackEndURI

public java.lang.String getBackEndURI()

connect

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

Creates a user session with the engine. Returns a sessionhandle for use in all other engine access methods.

Parameters:

userID - a valid user ID

password - a valid password

Returns:

the sessionHandle - expires after one hour.

Throws:

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

checkConnection

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

Checks that a session handle is active

Parameters:

sessionHandle - the handle to check

Returns:

true if the handle is active, false if not

Throws:

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

disconnect

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

Disconnects an external entity from the engine

Parameters:

handle - the sessionHandle to disconnect

Throws:

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

addYAWLService

public java.lang.String addYAWLService(YAWLServiceReference service,
                                       java.lang.String sessionHandle)
                                throws java.io.IOException

Registers a new custom YAWL service woth the engine.

Parameters:

service - the service.

sessionHandle - a valid sessionhandle

Returns:

a diagnostic XML message.

Throws:

java.io.IOException - if something goes awry.

removeYAWLService

public java.lang.String removeYAWLService(java.lang.String serviceURI,
                                          java.lang.String sessionHandle)
                                   throws java.io.IOException

Removes a YAWL service from the engine.

Parameters:

serviceURI - the service URI.

sessionHandle - a valid sessionhandle.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

getYAWLService

public YAWLServiceReference getYAWLService(java.lang.String serviceURI,
                                           java.lang.String sessionHandle)
                                    throws java.io.IOException

Throws:

java.io.IOException

getRegisteredYAWLServices

public java.util.Set<YAWLServiceReference> getRegisteredYAWLServices(java.lang.String sessionHandle)

Returns a list of YAWL service objects registered with the engine.

Parameters:

sessionHandle - a valid session handle

Returns:

the set of active yawl services

getRegisteredYAWLServicesAsXML

public java.lang.String getRegisteredYAWLServicesAsXML(java.lang.String sessionHandle)
                                                throws java.io.IOException

Returns an XML string list of YAWL services registered with the engine.

Parameters:

sessionHandle - an active handle

Returns:

XML string list of services or a diagnostic error message

Throws:

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

uploadSpecification

public java.lang.String uploadSpecification(java.lang.String specification,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Uploads a specification into the engine.

Parameters:

specification - this is *not* a file name, this is the entire specification xml file in string format.

sessionHandle - a sessionhandle.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

uploadSpecification

public java.lang.String uploadSpecification(java.lang.String specification,
                                            java.lang.String filename,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Deprecated. use uploadSpecification(String, String) instead (since 2.0)

Uploads a specification into the engine.

Parameters:

specification - this is *not* a file name, this is the entire specification xml file in string format.

filename - the file name of the specification xml file (no longer used since 2.0)

sessionHandle - a sessionhandle.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

uploadSpecification

public java.lang.String uploadSpecification(java.io.File file,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Uploads a specification into the engine.

Parameters:

file - the file name of the specification xml file

sessionHandle - a sessionhandle.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

unloadSpecification

public java.lang.String unloadSpecification(java.lang.String specID,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Deprecated. superceded by unloadSpecification(YSpecificationID, String) - this version is appropriate for pre-2.0 schema-based specs only

Unloads a loaded specification from the engine

Parameters:

specID - the id of the specification to unload

sessionHandle - a sessionhandle.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

unloadSpecification

public java.lang.String unloadSpecification(YSpecificationID specID,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Unloads a loaded specification from the engine

Parameters:

specID - the id of the specification to unload

sessionHandle - a sessionhandle.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

addClientAccount

public java.lang.String addClientAccount(java.lang.String name,
                                         java.lang.String password,
                                         java.lang.String documentation,
                                         java.lang.String sessionHandle)
                                  throws java.io.IOException

Creates a new user inside the engine.

Parameters:

name - the new username

password - the new password

documentation - some descriptive text about the account

sessionHandle - a current valid sessionhandle

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

addClientAccount

public java.lang.String addClientAccount(YExternalClient client,
                                         java.lang.String sessionHandle)
                                  throws java.io.IOException

Throws:

java.io.IOException

updateClientAccount

public java.lang.String updateClientAccount(java.lang.String name,
                                            java.lang.String password,
                                            java.lang.String documentation,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Throws:

java.io.IOException

getClientAccounts

public java.util.Set<YExternalClient> getClientAccounts(java.lang.String sessionHandle)
                                                 throws java.io.IOException

Gets all the client accounts registered in the engine

Parameters:

sessionHandle - a current valid sessionhandle of an admin type user.

Returns:

a diagnostic XML result message.

Throws:

java.io.IOException - if bad connection.

getClientAccount

public YExternalClient getClientAccount(java.lang.String userID,
                                        java.lang.String sessionHandle)
                                 throws java.io.IOException

Throws:

java.io.IOException

removeClientAccount

public java.lang.String removeClientAccount(java.lang.String name,
                                            java.lang.String sessionHandle)
                                     throws java.io.IOException

Delete an external client account PREcondition: cannot delete self

Parameters:

name - the user to delete

sessionHandle - an active handle

Returns:

diagnostic string of results from engine.

Throws:

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

changePassword

public java.lang.String changePassword(java.lang.String password,
                                       java.lang.String sessionHandle)
                                throws java.io.IOException

Change the password of a service or client account on the engine, the account being the owner of the session handle.

Parameters:

password - the new password

sessionHandle - an active handle

Returns:

diagnostic string of results from engine.

Throws:

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

getPassword

public java.lang.String getPassword(java.lang.String userid,
                                    java.lang.String sessionHandle)
                             throws java.io.IOException

Throws:

java.io.IOException

getBuildProperties

public java.lang.String getBuildProperties(java.lang.String sessionHandle)
                                    throws java.io.IOException

Throws:

java.io.IOException

getExternalDBGateways

public java.lang.String getExternalDBGateways(java.lang.String sessionHandle)
                                       throws java.io.IOException

Throws:

java.io.IOException

setHibernateStatisticsEnabled

public java.lang.String setHibernateStatisticsEnabled(boolean enabled,
                                                      java.lang.String sessionHandle)
                                               throws java.io.IOException

Throws:

java.io.IOException

isHibernateStatisticsEnabled

public java.lang.String isHibernateStatisticsEnabled(java.lang.String sessionHandle)
                                              throws java.io.IOException

Throws:

java.io.IOException

getHibernateStatistics

public java.lang.String getHibernateStatistics(java.lang.String sessionHandle)
                                        throws java.io.IOException

Throws:

java.io.IOException

promote

public java.lang.String promote(java.lang.String sessionHandle)
                         throws java.io.IOException

Throws:

java.io.IOException

demote

public java.lang.String demote(java.lang.String sessionHandle)
                        throws java.io.IOException

Throws:

java.io.IOException