Package org.imixs.workflow.jaxrs

Class ModelRestService

java.lang.Object

org.imixs.workflow.jaxrs.ModelRestService

@Path("/model")
@Produces({"text/html","application/xhtml+xml","application/xml","application/json","text/xml"})
public class ModelRestService
extends Object

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

Author:

rsoika

Constructor Summary

Constructors

Constructor	Description
ModelRestService()

Method Summary

Modifier and Type	Method	Description
void	deleteModel(String version)
jakarta.ws.rs.core.Response	findAllEventsByTask(String version, int taskID, String items, String format)
jakarta.ws.rs.core.Response	findAllTasks(String version, String items, String format)
jakarta.ws.rs.core.Response	findTasksByGroup(String version, String group, String items, String format)	Returns a list of all Tasks of a specific workflow group.
jakarta.ws.rs.core.Response	getDefiniton(String version, String items, String format)	Returns the model definition containing general model information (e.g.
jakarta.ws.rs.core.Response	getEvent(String version, int taskID, int eventID, String items, String format)	Returns the Task BPMN element by its ID and VersionID.
Set<String>	getGroups(String version, String items)	Returns a list of all Workflow Groups of the given model
jakarta.ws.rs.core.Response	getModelFile(String version, jakarta.ws.rs.core.UriInfo uriInfo)	Returns the XML representation of a BPMN model
jakarta.ws.rs.core.StreamingOutput	getModelOverview()
String	getModelXML()
jakarta.ws.rs.core.Response	getTask(String version, int taskID, String items, String format)	Returns the Task BPMN element by its ID and VersionID.
jakarta.ws.rs.core.Response	postBPMNModel(InputStream inputStream)
jakarta.ws.rs.core.Response	postBPMNModel(String filename, InputStream inputStream)
jakarta.ws.rs.core.Response	putBPMNModel(InputStream inputStream)
jakarta.ws.rs.core.Response	putBPMNModel(String filename, InputStream inputStream)	This method consumes a Imixs BPMN model file and updates the corresponding model information.

Methods inherited from class java.lang.Object

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

Constructor Details

ModelRestService

public ModelRestService()

Method Details

getModelOverview

@GET
@Produces("text/html")
public jakarta.ws.rs.core.StreamingOutput getModelOverview()

getModelXML

@GET
@Produces({"application/xml","text/xml"})
public String getModelXML()

findAllTasks

@GET
@Path("/{version}/tasks/")
public jakarta.ws.rs.core.Response findAllTasks(@PathParam("version")
 String version,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

getModelFile

@GET
@Path("/{version}/bpmn")
public jakarta.ws.rs.core.Response getModelFile(@PathParam("version")
 String version,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Returns the XML representation of a BPMN model

Parameters:

version -

uriInfo -

Returns:

getDefiniton

@GET
@Path("/{version}/definition")
public jakarta.ws.rs.core.Response getDefiniton(@PathParam("version")
 String version,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

Returns the model definition containing general model information (e.g. $ModelVersion).

getTask

@GET
@Path("/{version}/tasks/{taskid}")
public jakarta.ws.rs.core.Response getTask(@PathParam("version")
 String version,
 @PathParam("taskid")
 int taskID,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

Returns the Task BPMN element by its ID and VersionID.

Parameters:

version -

taskID -

items -

format -

Returns:

getEvent

@GET
@Path("/{version}/tasks/{taskid}/events/{eventid}")
public jakarta.ws.rs.core.Response getEvent(@PathParam("version")
 String version,
 @PathParam("taskid")
 int taskID,
 @PathParam("eventid")
 int eventID,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

Returns the Task BPMN element by its ID and VersionID.

Parameters:

version -

taskID -

items -

format -

Returns:

findAllEventsByTask

@GET
@Path("/{version}/tasks/{taskid}/events")
public jakarta.ws.rs.core.Response findAllEventsByTask(@PathParam("version")
 String version,
 @PathParam("taskid")
 int taskID,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

getGroups

@GET
@Path("/{version}/groups")
public Set<String> getGroups(@PathParam("version")
 String version,
 @QueryParam("items")
 String items)

Returns a list of all Workflow Groups of the given model

Parameters:

version -

Returns:

findTasksByGroup

@GET
@Path("/{version}/groups/{group}")
public jakarta.ws.rs.core.Response findTasksByGroup(@PathParam("version")
 String version,
 @PathParam("group")
 String group,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

Returns a list of all Tasks of a specific workflow group.

Parameters:

version -

Returns:

deleteModel

@DELETE
@Path("/{version}")
public void deleteModel(@PathParam("version")
 String version)

putBPMNModel

@PUT
@Path("/bpmn/{filename}")
@Consumes("application/octet-stream")
public jakarta.ws.rs.core.Response putBPMNModel(@PathParam("filename")
 String filename,
 InputStream inputStream)

This method consumes a Imixs BPMN model file and updates the corresponding model information.

Parameters:

model -

Returns:

postBPMNModel

@POST
@Path("/bpmn/{filename}")
@Consumes("application/octet-stream")
public jakarta.ws.rs.core.Response postBPMNModel(@PathParam("filename")
 String filename,
 InputStream inputStream)

putBPMNModel

@PUT
@Path("/bpmn")
@Consumes("application/octet-stream")
public jakarta.ws.rs.core.Response putBPMNModel(InputStream inputStream)

postBPMNModel

@POST
@Path("/bpmn")
@Consumes("application/octet-stream")
public jakarta.ws.rs.core.Response postBPMNModel(InputStream inputStream)