org.yawlfoundation.yawl.documentStore

Class DocumentStoreClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.documentStore.DocumentStoreClient

Direct Known Subclasses:

DocStoreClient

public class DocumentStoreClient
extends Interface_Client

An client-side interface to communicate with the YAWL Document Store

Author:

Michael Adams

Created/Last Date:

21/11/11

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_storeURI

Constructor Summary

Constructors

Constructor and Description
DocumentStoreClient() Constructs a new, empty DocumentStoreClient object
DocumentStoreClient(java.lang.String uri) Constructs a new DocumentStoreClient object

Method Summary

Modifier and Type	Method and Description
java.lang.String	addCaseID(long docID, java.lang.String caseID, java.lang.String handle) Updates a stored document with its case id.
boolean	checkConnection(java.lang.String handle) Check that a session handle is active
java.lang.String	clearCase(java.lang.String caseID, java.lang.String handle) Removes all documents from the Document Store matching a case id
java.lang.String	clearCase(YDocument doc, java.lang.String handle) Removes all documents from the Document Store matching a case id
java.lang.String	completeCase(java.lang.String caseID, java.lang.String handle) Removes all documents from the Document Store matching a case id
java.lang.String	completeCase(YDocument doc, java.lang.String handle) Removes all documents from the Document Store matching a case id
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the document store
void	disconnect(java.lang.String handle) Disconnects an external entity from the document store
YDocument	getDocument(long docID, java.lang.String handle) Gets a document from the Document Store
YDocument	getDocument(YDocument doc, java.lang.String handle) Gets a document from the Document Store
java.lang.String	putDocument(YDocument doc, java.lang.String handle) Stores a document in the Document Store
java.lang.String	removeDocument(long docID, java.lang.String handle) Removes a document from the Document Store
java.lang.String	removeDocument(YDocument doc, java.lang.String handle) Removes a document from the Document Store
void	setURI(java.lang.String uri) Sets the document store URI for this client

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

_storeURI

protected java.lang.String _storeURI

Constructor Detail

DocumentStoreClient

public DocumentStoreClient()

Constructs a new, empty DocumentStoreClient object

DocumentStoreClient

public DocumentStoreClient(java.lang.String uri)

Constructs a new DocumentStoreClient object

Parameters:

uri - the uri of the YAWL document store

Method Detail

setURI

public void setURI(java.lang.String uri)

Sets the document store URI for this client

Parameters:

uri - the uri of the YAWL document store

connect

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

Connects an external entity to the document store

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 boolean 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 handle is valid and active, "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 document store

Parameters:

handle - the sessionHandle to disconnect

Throws:

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

putDocument

public java.lang.String putDocument(YDocument doc,
                                    java.lang.String handle)
                             throws java.io.IOException

Stores a document in the Document Store

Parameters:

doc - the YDocument to store. If the YDocument's id matches an existing document in the Store, this 'put' is treated as an update rather that a new document insertion

handle - a valid session handle

Returns:

the document id (as a String) if successful, otherwise an error message

Throws:

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

getDocument

public YDocument getDocument(YDocument doc,
                             java.lang.String handle)
                      throws java.io.IOException

Gets a document from the Document Store

Parameters:

doc - the YDocument to get. The YDocument's id must match an existing document

handle - a valid session handle

Returns:

the YDocument with the document (i.e. the binary file) inserted, if successful

Throws:

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

getDocument

public YDocument getDocument(long docID,
                             java.lang.String handle)
                      throws java.io.IOException

Gets a document from the Document Store

Parameters:

docID - the id of the document to get. The id must match an existing document

handle - a valid session handle

Returns:

the YDocument with the document (i.e. the binary file) inserted, if successful

Throws:

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

removeDocument

public java.lang.String removeDocument(YDocument doc,
                                       java.lang.String handle)
                                throws java.io.IOException

Removes a document from the Document Store

Parameters:

doc - the YDocument to remove. The YDocument's id must match an existing document

handle - a valid session handle

Returns:

a success or error message

Throws:

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

removeDocument

public java.lang.String removeDocument(long docID,
                                       java.lang.String handle)
                                throws java.io.IOException

Removes a document from the Document Store

Parameters:

docID - the id of the document to remove. The id must match an existing document

handle - a valid session handle

Returns:

a success or error message

Throws:

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

addCaseID

public java.lang.String addCaseID(long docID,
                                  java.lang.String caseID,
                                  java.lang.String handle)
                           throws java.io.IOException

Updates a stored document with its case id. When a document is uploaded at case start, it occurs before the case has been launched and thus there is not yet a case id allocated. Once the case launch is successful, this method is called to associate the case id with the already uploaded document.

Parameters:

docID - the id of the already uploaded document

caseID - the case id of the case launched with the document as a case param

handle - a valid session handle

Returns:

a success or error message

Throws:

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

clearCase

public java.lang.String clearCase(YDocument doc,
                                  java.lang.String handle)
                           throws java.io.IOException

Removes all documents from the Document Store matching a case id

Parameters:

doc - a YDocument containing the case id of the documents to remove

handle - a valid session handle

Returns:

a success or error message

Throws:

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

clearCase

public java.lang.String clearCase(java.lang.String caseID,
                                  java.lang.String handle)
                           throws java.io.IOException

Removes all documents from the Document Store matching a case id

Parameters:

caseID - the case id of the documents to remove

handle - a valid session handle

Returns:

a success or error message

Throws:

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

completeCase

public java.lang.String completeCase(YDocument doc,
                                     java.lang.String handle)
                              throws java.io.IOException

Removes all documents from the Document Store matching a case id

Parameters:

doc - a YDocument containing the case id of the documents to remove

handle - a valid session handle

Returns:

a success or error message

Throws:

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

completeCase

public java.lang.String completeCase(java.lang.String caseID,
                                     java.lang.String handle)
                              throws java.io.IOException

Removes all documents from the Document Store matching a case id

Parameters:

caseID - the case id of the documents to remove

handle - a valid session handle

Returns:

a success or error message

Throws:

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