org.imixs.workflow.jaxrs

Class WorkflowRestService

java.lang.Object

org.imixs.workflow.jaxrs.WorkflowRestService

public class WorkflowRestService
extends Object

The WorkflowService Handler supports methods to process different kind of request URIs

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
WorkflowRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getEvents(String uniqueid, String format) Returns a collection of events of a workitem, visible to the current user
javax.ws.rs.core.StreamingOutput	getHelpHTML()
javax.ws.rs.core.Response	getTaskListByAuthor(String user, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format) Returns a collection of workitems representing the worklist by the current user
javax.ws.rs.core.Response	getTaskListByCreator(String creator, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format)
javax.ws.rs.core.Response	getTaskListByGroup(String processgroup, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format)
javax.ws.rs.core.Response	getTaskListByOwner(String owner, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format)
javax.ws.rs.core.Response	getTaskListByProcessID(int processid, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format)
javax.ws.rs.core.Response	getTaskListByRef(String uniqueid, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format)
javax.ws.rs.core.Response	getWorkItem(String uniqueid, String items, String format) returns a single workitem defined by $uniqueid
javax.ws.rs.core.Response	getWorkItemFile(String uniqueid, String file, javax.ws.rs.core.UriInfo uriInfo) Returns a file attachment located in the property $file of the specified workitem The file name will be encoded.
javax.ws.rs.core.Response	getWorkList(String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items, String format) Returns a collection of workitems representing the worklist by the current user
org.imixs.workflow.ItemCollection	parseWorkitem(InputStream requestBodyStream) This method expects a form post.
javax.ws.rs.core.Response	postFormWorkitem(InputStream requestBodyStream) This method expects a form post and processes the WorkItem by the WorkflowService EJB.
javax.ws.rs.core.Response	postFormWorkitemByUnqiueID(String uid, InputStream requestBodyStream) This method expects a form post and processes the WorkItem by the WorkflowService EJB.
javax.ws.rs.core.Response	postJSONWorkitem(InputStream requestBodyStream, String error, String encoding) This method expects a form post and processes the WorkItem by the WorkflowService EJB.
javax.ws.rs.core.Response	postJSONWorkitemByUniqueID(String uniqueid, InputStream requestBodyStream, String error, String encoding)
javax.ws.rs.core.Response	postWorkitemByUniqueIDJSONDeprecated(String uniqueid, InputStream requestBodyStream, String error, String encoding) Deprecated.
javax.ws.rs.core.Response	postWorkitemJSONDeprecated(InputStream requestBodyStream, String error, String encoding) Deprecated.
javax.ws.rs.core.Response	postWorkitems_XML(org.imixs.workflow.xml.XMLDataCollection worklist) This method post a collection of ItemCollection objects to be processed by the WorkflowManager.
javax.ws.rs.core.Response	postXMLWorkitem(org.imixs.workflow.xml.XMLDocument xmlworkitem) This method post a ItemCollection object to be processed by the WorkflowManager.
javax.ws.rs.core.Response	postXMLWorkitemByUniqueID(String uniqueid, org.imixs.workflow.xml.XMLDocument xmlworkitem)
javax.ws.rs.core.Response	putFormWorkitem(InputStream requestBodyStream) This method expects a form post.
javax.ws.rs.core.Response	putJSONWorkitem(InputStream requestBodyStream, String error, String encoding) Delegater for PUT postXMLWorkitemByUniqueID
javax.ws.rs.core.Response	putJSONWorkitemByUniqueID(String uniqueid, InputStream requestBodyStream, String error, String encoding) Delegater for PUT postJSONWorkitemByUniqueID
javax.ws.rs.core.Response	putWorkitems_XML(org.imixs.workflow.xml.XMLDataCollection worklist)
javax.ws.rs.core.Response	putXMLWorkitem(org.imixs.workflow.xml.XMLDocument workitem) Delegater
javax.ws.rs.core.Response	putXMLWorkitemByUniqueID(String uniqueid, org.imixs.workflow.xml.XMLDocument xmlworkitem) Delegater for PUT postXMLWorkitemByUniqueID

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowRestService

public WorkflowRestService()

Method Detail

getHelpHTML

public javax.ws.rs.core.StreamingOutput getHelpHTML()

getWorkItem

public javax.ws.rs.core.Response getWorkItem(String uniqueid,
                                             String items,
                                             String format)

returns a single workitem defined by $uniqueid

Parameters:

uniqueid -

Returns:

getWorkItemFile

public javax.ws.rs.core.Response getWorkItemFile(String uniqueid,
                                                 @Encoded
                                                 String file,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo uriInfo)

Returns a file attachment located in the property $file of the specified workitem

The file name will be encoded. With a URLDecode the filename is decoded in different formats and searched in the file list. This is not a nice solution.

Parameters:

uniqueid -

Returns:

getEvents

public javax.ws.rs.core.Response getEvents(String uniqueid,
                                           String format)

Returns a collection of events of a workitem, visible to the current user

Parameters:

uniqueid - of workitem

Returns:

list of event entities

getWorkList

public javax.ws.rs.core.Response getWorkList(String type,
                                             int pageIndex,
                                             int pageSize,
                                             String sortBy,
                                             Boolean sortReverse,
                                             String items,
                                             String format)

Returns a collection of workitems representing the worklist by the current user

Parameters:

start -

count -

type -

sortorder -

getTaskListByOwner

public javax.ws.rs.core.Response getTaskListByOwner(String owner,
                                                    String type,
                                                    int pageIndex,
                                                    int pageSize,
                                                    String sortBy,
                                                    Boolean sortReverse,
                                                    String items,
                                                    String format)

getTaskListByAuthor

public javax.ws.rs.core.Response getTaskListByAuthor(String user,
                                                     String type,
                                                     int pageIndex,
                                                     int pageSize,
                                                     String sortBy,
                                                     Boolean sortReverse,
                                                     String items,
                                                     String format)

Returns a collection of workitems representing the worklist by the current user

Parameters:

start -

count -

type -

sortorder -

getTaskListByCreator

public javax.ws.rs.core.Response getTaskListByCreator(String creator,
                                                      String type,
                                                      int pageIndex,
                                                      int pageSize,
                                                      String sortBy,
                                                      Boolean sortReverse,
                                                      String items,
                                                      String format)

getTaskListByProcessID

public javax.ws.rs.core.Response getTaskListByProcessID(int processid,
                                                        String type,
                                                        int pageIndex,
                                                        int pageSize,
                                                        String sortBy,
                                                        Boolean sortReverse,
                                                        String items,
                                                        String format)

getTaskListByGroup

public javax.ws.rs.core.Response getTaskListByGroup(String processgroup,
                                                    String type,
                                                    int pageIndex,
                                                    int pageSize,
                                                    String sortBy,
                                                    Boolean sortReverse,
                                                    String items,
                                                    String format)

getTaskListByRef

public javax.ws.rs.core.Response getTaskListByRef(String uniqueid,
                                                  String type,
                                                  int pageIndex,
                                                  int pageSize,
                                                  String sortBy,
                                                  Boolean sortReverse,
                                                  String items,
                                                  String format)

postFormWorkitem

public javax.ws.rs.core.Response postFormWorkitem(InputStream requestBodyStream)

This method expects a form post and processes the WorkItem by the WorkflowService EJB. After the workItem was processed the method redirect the request to the provided action URI. The action URI can also be computed by the Imixs Workflow ResutlPlugin

Parameters:

requestBodyStream - - form content

action - - return URI

Returns:

postFormWorkitemByUnqiueID

public javax.ws.rs.core.Response postFormWorkitemByUnqiueID(String uid,
                                                            InputStream requestBodyStream)

This method expects a form post and processes the WorkItem by the WorkflowService EJB. After the workItem was processed the method redirect the request to the provided action URI. The action URI can also be computed by the Imixs Workflow ResutlPlugin

Parameters:

requestBodyStream - - form content

action - - return URI

Returns:

putFormWorkitem

public javax.ws.rs.core.Response putFormWorkitem(InputStream requestBodyStream)

This method expects a form post.

Parameters:

requestBodyStream -

Returns:

See Also:

putWorkitemDefault

postXMLWorkitem

public javax.ws.rs.core.Response postXMLWorkitem(org.imixs.workflow.xml.XMLDocument xmlworkitem)

This method post a ItemCollection object to be processed by the WorkflowManager. The method test for the properties $taskidid and $eventid NOTE!! - this method did not update an existing instance of a workItem. The behavior is different to the method putWorkitem(). It need to be discussed if the behavior is wrong or not.

Parameters:

workitem - - new workItem data

putXMLWorkitem

public javax.ws.rs.core.Response putXMLWorkitem(org.imixs.workflow.xml.XMLDocument workitem)

Delegater

Parameters:

workitem -

Returns:

postXMLWorkitemByUniqueID

public javax.ws.rs.core.Response postXMLWorkitemByUniqueID(String uniqueid,
                                                           org.imixs.workflow.xml.XMLDocument xmlworkitem)

putXMLWorkitemByUniqueID

public javax.ws.rs.core.Response putXMLWorkitemByUniqueID(String uniqueid,
                                                          org.imixs.workflow.xml.XMLDocument xmlworkitem)

Delegater for PUT postXMLWorkitemByUniqueID

Parameters:

workitem -

Returns:

postJSONWorkitem

public javax.ws.rs.core.Response postJSONWorkitem(InputStream requestBodyStream,
                                                  String error,
                                                  String encoding)

This method expects a form post and processes the WorkItem by the WorkflowService EJB. The Method returns a JSON object with the new data. If a processException Occurs the method returns a JSON object with the error code The JSON result is computed by the service because JSON is not standardized and differs between different jax-rs implementations. For that reason it can not be directly re-converted XMLItemCollection generated by this method Output format: ... value":{"@type":"xs:int","$":"10"}

Parameters:

requestBodyStream - - form content

Returns:

JSON object

Throws:

Exception

putJSONWorkitem

public javax.ws.rs.core.Response putJSONWorkitem(InputStream requestBodyStream,
                                                 String error,
                                                 String encoding)

Delegater for PUT postXMLWorkitemByUniqueID

Parameters:

workitem -

Returns:

postJSONWorkitemByUniqueID

public javax.ws.rs.core.Response postJSONWorkitemByUniqueID(String uniqueid,
                                                            InputStream requestBodyStream,
                                                            String error,
                                                            String encoding)

putJSONWorkitemByUniqueID

public javax.ws.rs.core.Response putJSONWorkitemByUniqueID(String uniqueid,
                                                           InputStream requestBodyStream,
                                                           String error,
                                                           String encoding)

Delegater for PUT postJSONWorkitemByUniqueID

Parameters:

workitem -

Returns:

postWorkitems_XML

public javax.ws.rs.core.Response postWorkitems_XML(org.imixs.workflow.xml.XMLDataCollection worklist)

This method post a collection of ItemCollection objects to be processed by the WorkflowManager.

Parameters:

worklist - - workitem list data

putWorkitems_XML

public javax.ws.rs.core.Response putWorkitems_XML(org.imixs.workflow.xml.XMLDataCollection worklist)

parseWorkitem

public org.imixs.workflow.ItemCollection parseWorkitem(InputStream requestBodyStream)

This method expects a form post. The method parses the input stream to extract the provides field/value pairs. NOTE: The method did not(!) assume that the put/post request contains a complete workItem. For this reason the method loads the existing instance of the corresponding workItem (identified by the $uniqueid) and adds the values provided by the put/post request into the existing instance. The following kind of lines which can be included in the InputStream will be skipped ------------------------------1a26f3661ff7 Content-Disposition: form-data; name="query" Connection: keep-alive Content-Type: multipart/form-data; boundary=---------------------------195571638125373 Content-Length: 5680 -----------------------------195571638125373

Parameters:

requestBodyStream -

Returns:

a workitem

postWorkitemByUniqueIDJSONDeprecated

@Deprecated
public javax.ws.rs.core.Response postWorkitemByUniqueIDJSONDeprecated(String uniqueid,
                                                                                  InputStream requestBodyStream,
                                                                                  String error,
                                                                                  String encoding)

Deprecated.

postWorkitemJSONDeprecated

@Deprecated
public javax.ws.rs.core.Response postWorkitemJSONDeprecated(InputStream requestBodyStream,
                                                                        String error,
                                                                        String encoding)

Deprecated.

uri was introduced with 4.0 but should be removed with 4.1

Parameters:

requestBodyStream -

error -

encoding -

Returns: