org.imixs.workflow.jaxrs

Class AdminPRestService

java.lang.Object

org.imixs.workflow.jaxrs.AdminPRestService

@Path(value="/adminp")
 @Produces(value={"text/html","application/xml","application/json","text/xml"})
public class AdminPRestService
extends Object

The AdminPRestService provides methods to access the AdminPService EJB

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
AdminPRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteJob(String uniqueid) This method deletes an entity
org.imixs.workflow.xml.XMLDataCollection	getAllJobs() Returns all existing jobs
javax.ws.rs.core.StreamingOutput	getHelpHTML()
javax.ws.rs.core.Response	putJob(org.imixs.workflow.xml.XMLDocument xmlworkitem) This method saves a entity provided in xml format Note: the method merges the content of the given entity into an existing one because the EntityService method save() did not merge an entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminPRestService

public AdminPRestService()

Method Detail

getHelpHTML

@GET
 @Produces(value="text/html")
 @Path(value="/help")
public javax.ws.rs.core.StreamingOutput getHelpHTML()

getAllJobs

@GET
 @Path(value="/jobs")
public org.imixs.workflow.xml.XMLDataCollection getAllJobs()

Returns all existing jobs

Parameters:

query -

pageSize -

pageIndex -

items -

Returns:

putJob

@POST
 @Path(value="/jobs/")
 @Produces(value="application/xml")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putJob(org.imixs.workflow.xml.XMLDocument xmlworkitem)

This method saves a entity provided in xml format Note: the method merges the content of the given entity into an existing one because the EntityService method save() did not merge an entity. But the rest service typically consumes only a subset of attributes. So this is the reason why we merge the entity here. In different to the behavior of the EntityService the WorkflowService method process() did this merge automatically.

Parameters:

xmlworkitem - - entity to be saved

Returns:

deleteJob

@DELETE
 @Path(value="/jobs/{uniqueid}")
public javax.ws.rs.core.Response deleteJob(@PathParam(value="uniqueid")
                                                                                    String uniqueid)

This method deletes an entity