Package org.cristalise.restapi

Class SchemaAccess

java.lang.Object

org.cristalise.restapi.RestHandler

org.cristalise.restapi.ItemUtils

org.cristalise.restapi.ResourceAccess

org.cristalise.restapi.SchemaAccess

@Path("/schema")
public class SchemaAccess
extends ResourceAccess

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
SchemaAccess()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getSchema(javax.ws.rs.core.HttpHeaders headers, String name, Integer version, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	getSchemaFormTemplate(javax.ws.rs.core.HttpHeaders headers, String name, Integer version, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	getSchemaViewTemplate(javax.ws.rs.core.HttpHeaders headers, String name, Integer version, javax.ws.rs.core.Cookie authCookie)
javax.ws.rs.core.Response	listAllSchemas(Integer start, Integer batchSize, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	listSchemaVersions(String name, javax.ws.rs.core.Cookie authCookie, javax.ws.rs.core.UriInfo uri)

Methods inherited from class org.cristalise.restapi.ResourceAccess

getResource, getResourceVersions, listAllResources, listResourceVersions

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

SchemaAccess

public SchemaAccess()

Method Details

listAllSchemas

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listAllSchemas(@DefaultValue("0") @QueryParam("start")
 Integer start,
 @QueryParam("batch")
 Integer batchSize,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

listSchemaVersions

@GET
@Path("{name}")
@Produces("application/json")
public javax.ws.rs.core.Response listSchemaVersions(@PathParam("name")
 String name,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie,
 @Context
 javax.ws.rs.core.UriInfo uri)

getSchema

@GET
@Path("{name}/{version}")
@Produces({"text/xml","application/xml","application/json"})
public javax.ws.rs.core.Response getSchema(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String name,
 @PathParam("version")
 Integer version,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getSchemaFormTemplate

@GET
@Path("{name}/{version}/formTemplate")
@Produces("application/json")
public javax.ws.rs.core.Response getSchemaFormTemplate(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String name,
 @PathParam("version")
 Integer version,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)

getSchemaViewTemplate

@GET
@Path("{name}/{version}/viewTemplate")
@Produces("application/json")
public javax.ws.rs.core.Response getSchemaViewTemplate(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String name,
 @PathParam("version")
 Integer version,
 @CookieParam("cauth")
 javax.ws.rs.core.Cookie authCookie)