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
org.imixs.workflow.xml.DocumentCollection	getEvents(String uniqueid) Returns a collection of events of a workitem, visible to the current user
javax.ws.rs.core.StreamingOutput	getHelpHTML()
org.imixs.workflow.xml.DocumentCollection	getTaskListByAuthor(String user, String type, int pageIndex, int pageSize, int sortorder, String items) Returns a collection of workitems representing the worklist by the current user
org.imixs.workflow.xml.DocumentCollection	getTaskListByCreator(String creator, String type, int pageIndex, int pageSize, int sortorder, String items)
org.imixs.workflow.xml.DocumentCollection	getTaskListByGroup(String processgroup, String type, int pageIndex, int pageSize, int sortorder, String items)
org.imixs.workflow.xml.DocumentCollection	getTaskListByOwner(String owner, String type, int pageIndex, int pageSize, int sortorder, String items)
org.imixs.workflow.xml.DocumentCollection	getTaskListByProcessID(int processid, String type, int pageIndex, int pageSize, int sortorder, String items)
org.imixs.workflow.xml.DocumentCollection	getTaskListByRef(String uniqueid, String type, int pageIndex, int pageSize, int sortorder, String items)
org.imixs.workflow.xml.XMLItemCollection	getWorkItem(String uniqueid, String items) returns a singel 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.
org.imixs.workflow.xml.DocumentCollection	getWorkList(String type, int pageIndex, int pageSize, int sortorder, String items) Returns a collection of workitems representing the worklist by the current user
static org.imixs.workflow.ItemCollection	parseWorkitem(InputStream requestBodyStream) This method expects a form post.
javax.ws.rs.core.Response	postWorkitem(InputStream requestBodyStream) This method expects a form post.
javax.ws.rs.core.Response	postWorkitemByUniqueIDJSON(String uniqueid, InputStream requestBodyStream, String error, String encoding)
javax.ws.rs.core.Response	postWorkitemByUniqueIDXML(String uniqueid, org.imixs.workflow.xml.XMLItemCollection xmlworkitem)
javax.ws.rs.core.Response	postWorkitemJSON(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	postWorkitemsXML(org.imixs.workflow.xml.DocumentCollection worklist)
javax.ws.rs.core.Response	postWorkitemXML(org.imixs.workflow.xml.XMLItemCollection xmlworkitem) This method post a ItemCollection object to be processed by the WorkflowManager.
javax.ws.rs.core.Response	putWorkitem(InputStream requestBodyStream) This method expects a form post and processes the WorkItem by the WorkflowService EJB.
javax.ws.rs.core.Response	putWorkitemsXML(org.imixs.workflow.xml.DocumentCollection worklist) This method post a collection of ItemCollection objects to be processed by the WorkflowManager.
javax.ws.rs.core.Response	putWorkitemXML(org.imixs.workflow.xml.XMLItemCollection workitem)

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 org.imixs.workflow.xml.XMLItemCollection getWorkItem(String uniqueid,
                                                            String items)

returns a singel 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 org.imixs.workflow.xml.DocumentCollection getEvents(String uniqueid)

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

Parameters:

uniqueid - of workitem

Returns:

list of event entities

getWorkList

public org.imixs.workflow.xml.DocumentCollection getWorkList(String type,
                                                             int pageIndex,
                                                             int pageSize,
                                                             int sortorder,
                                                             String items)

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

Parameters:

start -

count -

type -

sortorder -

getTaskListByOwner

public org.imixs.workflow.xml.DocumentCollection getTaskListByOwner(String owner,
                                                                    String type,
                                                                    int pageIndex,
                                                                    int pageSize,
                                                                    int sortorder,
                                                                    String items)

getTaskListByAuthor

public org.imixs.workflow.xml.DocumentCollection getTaskListByAuthor(String user,
                                                                     String type,
                                                                     int pageIndex,
                                                                     int pageSize,
                                                                     int sortorder,
                                                                     String items)

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

Parameters:

start -

count -

type -

sortorder -

getTaskListByCreator

public org.imixs.workflow.xml.DocumentCollection getTaskListByCreator(String creator,
                                                                      String type,
                                                                      int pageIndex,
                                                                      int pageSize,
                                                                      int sortorder,
                                                                      String items)

getTaskListByProcessID

public org.imixs.workflow.xml.DocumentCollection getTaskListByProcessID(int processid,
                                                                        String type,
                                                                        int pageIndex,
                                                                        int pageSize,
                                                                        int sortorder,
                                                                        String items)

getTaskListByGroup

public org.imixs.workflow.xml.DocumentCollection getTaskListByGroup(String processgroup,
                                                                    String type,
                                                                    int pageIndex,
                                                                    int pageSize,
                                                                    int sortorder,
                                                                    String items)

getTaskListByRef

public org.imixs.workflow.xml.DocumentCollection getTaskListByRef(String uniqueid,
                                                                  String type,
                                                                  int pageIndex,
                                                                  int pageSize,
                                                                  int sortorder,
                                                                  String items)

putWorkitem

public javax.ws.rs.core.Response putWorkitem(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:

postWorkitem

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

This method expects a form post.

Parameters:

requestBodyStream -

Returns:

See Also:

putWorkitemDefault

postWorkitemXML

public javax.ws.rs.core.Response postWorkitemXML(org.imixs.workflow.xml.XMLItemCollection xmlworkitem)

This method post a ItemCollection object to be processed by the WorkflowManager. The method test for the properties $processid and $activityid 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

postWorkitemByUniqueIDXML

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

putWorkitemXML

public javax.ws.rs.core.Response putWorkitemXML(org.imixs.workflow.xml.XMLItemCollection workitem)

postWorkitemJSON

public javax.ws.rs.core.Response postWorkitemJSON(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

postWorkitemByUniqueIDJSON

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

putWorkitemsXML

public javax.ws.rs.core.Response putWorkitemsXML(org.imixs.workflow.xml.DocumentCollection worklist)

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

Parameters:

worklist - - workitem list data

postWorkitemsXML

public javax.ws.rs.core.Response postWorkitemsXML(org.imixs.workflow.xml.DocumentCollection worklist)

parseWorkitem

public static final 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 $unqiueid) 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