org.cristalise.restapi

Class ItemRoot

java.lang.Object

org.cristalise.restapi.RestHandler

org.cristalise.restapi.ItemUtils

org.cristalise.restapi.ItemRoot

@Path(value="/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 and Description
ItemRoot()

Method Summary

Modifier and Type	Method and 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	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	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(String postData, InputStream file, javax.ws.rs.core.HttpHeaders headers, String uuid, String actPath, String transition, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri) Method for handling binary uplaod POST methods
String	requestTransition(String postData, 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, executePredefinedStep, 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 Detail

ItemRoot

public ItemRoot()

Method Detail

getName

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

getAliases

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

getMasterOutcome

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

getScriptResult

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

getScriptResultPost

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

getQueryResult

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

getItemSummary

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

Throws:

Exception

getJobs

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

requestTransition

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

requestBinaryTransition

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="multipart/form-data")
 @Path(value="{binaryUploadPath: .*}")
public String requestBinaryTransition(String postData,
                                                                                                                                                                   InputStream file,
                                                                                                                                                                   @Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="uuid")
                                                                                                                                                                   String uuid,
                                                                                                                                                                   @PathParam(value="binaryUploadPath")
                                                                                                                                                                   String actPath,
                                                                                                                                                                   @QueryParam(value="transition")
                                                                                                                                                                   String transition,
                                                                                                                                                                   @CookieParam(value="cauth")
                                                                                                                                                                   javax.ws.rs.core.Cookie authCookie,
                                                                                                                                                                   @Context
                                                                                                                                                                   javax.ws.rs.core.UriInfo uri)

Method for handling binary uplaod POST methods

Parameters:

postData -

headers -

uuid -

actPath -

transition -

authCookie -

uri -

Returns:

getJobFormTemplate

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