Package org.cristalise.restapi

Class ItemRoot

java.lang.Object

org.cristalise.restapi.RestHandler

org.cristalise.restapi.ItemUtils

org.cristalise.restapi.ItemRoot

@Path("/item/{uuid}")
public class ItemRoot
extends ItemUtils

Nested Class Summary

Nested classes/interfaces inherited from class org.cristalise.restapi.RestHandler

RestHandler.AuthData

Field Summary

Fields inherited from class org.cristalise.restapi.ItemUtils

PREDEFINED_PATH

Fields inherited from class org.cristalise.restapi.RestHandler

COOKIENAME, PASSWORD, USERNAME

Constructor Summary

Constructors

Constructor	Description
ItemRoot()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getAliases(String uuid, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	getItemSummary(String uuid, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	getJobFormLayout(javax.ws.rs.core.HttpHeaders headers, String uuid, String actPath, String transition, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	getJobFormModel(javax.ws.rs.core.HttpHeaders headers, String uuid, String actPath, String transition, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	getJobFormTemplate(javax.ws.rs.core.HttpHeaders headers, String uuid, String actPath, String transition, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	getJobs(String uuid, String agentName, String activityName, String transitionName, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	getMasterOutcome(javax.ws.rs.core.HttpHeaders headers, String uuid, String schemaName, Integer schemaVersion, String scriptName, Integer scriptVersion, javax.ws.rs.core.Cookie authCookie)
String	getName(String uuid, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	getQueryResult(javax.ws.rs.core.HttpHeaders headers, String uuid, String queryName, Integer queryVersion, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	getRoles(String uuid, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	getScriptResult(javax.ws.rs.core.HttpHeaders headers, String uuid, String scriptName, Integer scriptVersion, String actPath, String inputJson, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	getScriptResultPost(String postData, javax.ws.rs.core.HttpHeaders headers, String uuid, String scriptName, Integer scriptVersion, String actPath, javax.ws.rs.core.Cookie authCookie)
String	requestBinaryTransition(org.glassfish.jersey.media.multipart.FormDataMultiPart body, javax.ws.rs.core.HttpHeaders headers, String uuid, String actPath, String transition, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
String	requestTransition(String outcome, javax.ws.rs.core.HttpHeaders headers, String uuid, String actPath, String transition, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)

Methods inherited from class org.cristalise.restapi.ItemUtils

enumerate, enumerate, executeJob, executeJob, executePredefinedStep, getAgentProxy, getAgentProxy, getAllViewpoints, getItemName, getItemNames, getItemURI, getItemURI, getItemURI, getItemURI, getJobActivityData, getJobItemData, getJobOutcomeData, getJobTransitionData, getOutcome, getOutcomeResponse, getOutcomeResponse, getOutcomeResponse, getPropertySummary, getProxy, getViewpointOutcome, makeCollectionData, makeEventData, makeJobData, produceJSON

Methods inherited from class org.cristalise.restapi.RestHandler

checkAndCreateNewCookie, checkAndCreateNewCookie, checkAuthCookie, createNewCookie, createNewCookie, decryptAuthData, encryptAuthData, getAgent, getAgent, getAgentPath, getPagedResult, getPropertiesFromQParams, makeItemDomainPathsData, toJSON

Methods inherited from class java.lang.Object

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

Constructor Details

ItemRoot

public ItemRoot()

Method Details

getName

@GET
@Path("name")
@Produces("text/plain")
public String getName(@PathParam("uuid")
 String uuid,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getAliases

@GET
@Path("aliases")
@Produces("application/json")
public javax.ws.rs.core.Response getAliases(@PathParam("uuid")
 String uuid,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getMasterOutcome

@GET
@Path("master")
@Produces({"text/xml","application/xml","application/json"})
public javax.ws.rs.core.Response getMasterOutcome(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @QueryParam("schema")
 String schemaName,
 @QueryParam("schemaVersion")
 Integer schemaVersion,
 @QueryParam("script")
 String scriptName,
 @QueryParam("scriptVersion")
 Integer scriptVersion,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getScriptResult

@GET
@Path("scriptResult")
@Produces({"text/xml","application/xml","application/json"})
public javax.ws.rs.core.Response getScriptResult(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @QueryParam("script")
 String scriptName,
 @QueryParam("version")
 Integer scriptVersion,
 @QueryParam("activityPath")
 String actPath,
 @QueryParam("inputs")
 String inputJson,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getScriptResultPost

@POST
@Path("scriptResult")
@Consumes({"text/xml","application/xml","application/json","text/plain"})
@Produces({"text/xml","application/xml","application/json"})
public javax.ws.rs.core.Response getScriptResultPost(String postData,
 @Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @QueryParam("script")
 String scriptName,
 @QueryParam("version")
 Integer scriptVersion,
 @QueryParam("activityPath")
 String actPath,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getQueryResult

@GET
@Path("queryResult")
@Produces({"text/xml","application/xml","application/json"})
public javax.ws.rs.core.Response getQueryResult(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @QueryParam("query")
 String queryName,
 @QueryParam("version")
 Integer queryVersion,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getItemSummary

@GET
@Produces("application/json")
public javax.ws.rs.core.Response getItemSummary(@PathParam("uuid")
 String uuid,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)
                                         throws Exception

Throws:

Exception

getJobs

@GET
@Path("job")
@Produces("application/json")
public javax.ws.rs.core.Response getJobs(@PathParam("uuid")
 String uuid,
 @QueryParam("agent")
 String agentName,
 @QueryParam("activityName")
 String activityName,
 @QueryParam("transitionName")
 String transitionName,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

requestTransition

@POST
@Consumes({"text/plain","text/xml","application/xml","application/json"})
@Produces({"text/xml","application/xml","application/json"})
@Path("{activityPath: .*}")
public String requestTransition(String outcome,
 @Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @PathParam("activityPath")
 String actPath,
 @QueryParam("transition")
 String transition,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

requestBinaryTransition

@POST
@Consumes("multipart/form-data")
@Produces({"text/xml","application/xml","application/json"})
@Path("{binaryUploadPath: .*}")
public String requestBinaryTransition(org.glassfish.jersey.media.multipart.FormDataMultiPart body,
 @Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @PathParam("binaryUploadPath")
 String actPath,
 @QueryParam("transition")
 String transition,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

getJobFormModel

@GET
@Produces("application/json")
@Path("job/formModel/{activityPath: .*}")
public javax.ws.rs.core.Response getJobFormModel(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @PathParam("activityPath")
 String actPath,
 @QueryParam("transition")
 String transition,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

getJobFormLayout

@GET
@Produces("application/json")
@Path("job/formLayout/{activityPath: .*}")
public javax.ws.rs.core.Response getJobFormLayout(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @PathParam("activityPath")
 String actPath,
 @QueryParam("transition")
 String transition,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

getJobFormTemplate

@GET
@Produces("application/json")
@Path("job/formTemplate/{activityPath: .*}")
public javax.ws.rs.core.Response getJobFormTemplate(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("uuid")
 String uuid,
 @PathParam("activityPath")
 String actPath,
 @QueryParam("transition")
 String transition,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

getRoles

@GET
@Path("roles")
@Produces("application/json")
public javax.ws.rs.core.Response getRoles(@PathParam("uuid")
 String uuid,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)