org.cristalise.restapi

Class ItemUtils

java.lang.Object

org.cristalise.restapi.RestHandler

org.cristalise.restapi.ItemUtils

Direct Known Subclasses:

AgentJobList, ItemCollection, ItemHistory, ItemOutcome, ItemOutcomeAttachment, ItemProperty, ItemRoot, ItemViewpoint, ItemWorkflow, ResourceAccess, ScriptUtils

public abstract class ItemUtils
extends RestHandler

Nested Class Summary

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

RestHandler.AuthData

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PREDEFINED_PATH

Fields inherited from class org.cristalise.restapi.RestHandler

COOKIENAME, PASSWORD, USERNAME

Constructor Summary

Constructors

Constructor and Description
ItemUtils()

Method Summary

Modifier and Type	Method and Description
ArrayList<LinkedHashMap<String,Object>>	enumerate(ItemProxy item, ClusterType cluster, String uriPath, javax.ws.rs.core.UriInfo uri, javax.ws.rs.core.NewCookie cookie)
ArrayList<LinkedHashMap<String,Object>>	enumerate(ItemProxy item, String dataPath, String uriPath, javax.ws.rs.core.UriInfo uri, javax.ws.rs.core.NewCookie cookie)
protected String	executeJob(ItemProxy item, String postData, String contentType, String actPath, String transition, AgentProxy agent)
protected String	executePredefinedStep(ItemProxy item, String postData, String contentType, String actPath, AgentProxy agent)
protected ArrayList<LinkedHashMap<String,Object>>	getAllViewpoints(ItemProxy item, javax.ws.rs.core.UriInfo uri, javax.ws.rs.core.NewCookie cookie)
protected String	getItemName(ItemPath ip)
static List<String>	getItemNames(Property... props)
protected static URI	getItemURI(javax.ws.rs.core.UriInfo uri, ItemPath item, Object... path)
protected static URI	getItemURI(javax.ws.rs.core.UriInfo uri, ItemProxy item, Object... path)
protected static URI	getItemURI(javax.ws.rs.core.UriInfo uri, Object... segments)
protected static URI	getItemURI(javax.ws.rs.core.UriInfo uri, UUID item, Object... path)
protected LinkedHashMap<String,Object>	getJobActivityData(Job job, String itemName, javax.ws.rs.core.UriInfo uri)
protected LinkedHashMap<String,Object>	getJobItemData(Job job, String itemName, javax.ws.rs.core.UriInfo uri)
protected LinkedHashMap<String,Object>	getJobOutcomeData(Job job, String itemName, javax.ws.rs.core.UriInfo uri)
protected LinkedHashMap<String,Object>	getJobTransitionData(Job job, String itemName, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response.ResponseBuilder	getOutcome(String uuid, String schema, int version, int eventId, boolean json, javax.ws.rs.core.NewCookie cookie)
protected javax.ws.rs.core.Response.ResponseBuilder	getOutcomeResponse(Outcome oc, boolean json, javax.ws.rs.core.NewCookie cookie) Creates Response with without any specific header.
protected javax.ws.rs.core.Response.ResponseBuilder	getOutcomeResponse(Outcome oc, Date eventDate, boolean json, javax.ws.rs.core.NewCookie cookie) Creates Response with header 'Last-Modified: '
protected javax.ws.rs.core.Response.ResponseBuilder	getOutcomeResponse(Outcome oc, Event ev, boolean json, javax.ws.rs.core.NewCookie cookie)
protected static ArrayList<LinkedHashMap<String,String>>	getPropertySummary(ItemProxy item)
protected ItemProxy	getProxy(String uuid, javax.ws.rs.core.NewCookie cookie)
javax.ws.rs.core.Response.ResponseBuilder	getViewpointOutcome(String uuid, String schema, String viewName, boolean json, javax.ws.rs.core.NewCookie cookie)
protected LinkedHashMap<String,Object>	makeCollectionData(Collection<?> coll, javax.ws.rs.core.UriInfo uri)
protected LinkedHashMap<String,Object>	makeEventData(Event ev, javax.ws.rs.core.UriInfo uri)
protected LinkedHashMap<String,Object>	makeJobData(Job job, String itemName, javax.ws.rs.core.UriInfo uri)
static boolean	produceJSON(List<javax.ws.rs.core.MediaType> types) Check if the requested media type should be a JSON or XML

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

Field Detail

PREDEFINED_PATH

protected static final String PREDEFINED_PATH

See Also:

Constant Field Values

Constructor Detail

ItemUtils

public ItemUtils()

Method Detail

getItemURI

protected static URI getItemURI(javax.ws.rs.core.UriInfo uri,
                                ItemProxy item,
                                Object... path)

getItemURI

protected static URI getItemURI(javax.ws.rs.core.UriInfo uri,
                                ItemPath item,
                                Object... path)

getItemURI

protected static URI getItemURI(javax.ws.rs.core.UriInfo uri,
                                UUID item,
                                Object... path)

getItemURI

protected static URI getItemURI(javax.ws.rs.core.UriInfo uri,
                                Object... segments)

getPropertySummary

protected static ArrayList<LinkedHashMap<String,String>> getPropertySummary(ItemProxy item)
                                                                     throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getProxy

protected ItemProxy getProxy(String uuid,
                             javax.ws.rs.core.NewCookie cookie)

getViewpointOutcome

public javax.ws.rs.core.Response.ResponseBuilder getViewpointOutcome(String uuid,
                                                                     String schema,
                                                                     String viewName,
                                                                     boolean json,
                                                                     javax.ws.rs.core.NewCookie cookie)

getOutcome

public javax.ws.rs.core.Response.ResponseBuilder getOutcome(String uuid,
                                                            String schema,
                                                            int version,
                                                            int eventId,
                                                            boolean json,
                                                            javax.ws.rs.core.NewCookie cookie)

enumerate

public ArrayList<LinkedHashMap<String,Object>> enumerate(ItemProxy item,
                                                         ClusterType cluster,
                                                         String uriPath,
                                                         javax.ws.rs.core.UriInfo uri,
                                                         javax.ws.rs.core.NewCookie cookie)

enumerate

public ArrayList<LinkedHashMap<String,Object>> enumerate(ItemProxy item,
                                                         String dataPath,
                                                         String uriPath,
                                                         javax.ws.rs.core.UriInfo uri,
                                                         javax.ws.rs.core.NewCookie cookie)

getAllViewpoints

protected ArrayList<LinkedHashMap<String,Object>> getAllViewpoints(ItemProxy item,
                                                                   javax.ws.rs.core.UriInfo uri,
                                                                   javax.ws.rs.core.NewCookie cookie)
                                                            throws Exception

Throws:

Exception

getOutcomeResponse

protected javax.ws.rs.core.Response.ResponseBuilder getOutcomeResponse(Outcome oc,
                                                                       boolean json,
                                                                       javax.ws.rs.core.NewCookie cookie)

Creates Response with without any specific header.

Parameters:

oc - the Outcome to convert

json - produce json or xml

Returns:

the ws ResponseBuilder

getOutcomeResponse

protected javax.ws.rs.core.Response.ResponseBuilder getOutcomeResponse(Outcome oc,
                                                                       Date eventDate,
                                                                       boolean json,
                                                                       javax.ws.rs.core.NewCookie cookie)

Creates Response with header 'Last-Modified: '

Parameters:

oc - the Outcome to convert

json - produce json or xml

Returns:

the ws ResponseBuilder

getOutcomeResponse

protected javax.ws.rs.core.Response.ResponseBuilder getOutcomeResponse(Outcome oc,
                                                                       Event ev,
                                                                       boolean json,
                                                                       javax.ws.rs.core.NewCookie cookie)

makeEventData

protected LinkedHashMap<String,Object> makeEventData(Event ev,
                                                     javax.ws.rs.core.UriInfo uri)

makeJobData

protected LinkedHashMap<String,Object> makeJobData(Job job,
                                                   String itemName,
                                                   javax.ws.rs.core.UriInfo uri)

getJobItemData

protected LinkedHashMap<String,Object> getJobItemData(Job job,
                                                      String itemName,
                                                      javax.ws.rs.core.UriInfo uri)

getJobActivityData

protected LinkedHashMap<String,Object> getJobActivityData(Job job,
                                                          String itemName,
                                                          javax.ws.rs.core.UriInfo uri)

getJobTransitionData

protected LinkedHashMap<String,Object> getJobTransitionData(Job job,
                                                            String itemName,
                                                            javax.ws.rs.core.UriInfo uri)

getJobOutcomeData

protected LinkedHashMap<String,Object> getJobOutcomeData(Job job,
                                                         String itemName,
                                                         javax.ws.rs.core.UriInfo uri)

getItemName

protected String getItemName(ItemPath ip)

makeCollectionData

protected LinkedHashMap<String,Object> makeCollectionData(Collection<?> coll,
                                                          javax.ws.rs.core.UriInfo uri)

produceJSON

public static boolean produceJSON(List<javax.ws.rs.core.MediaType> types)
                           throws UnsupportedOperationException

Check if the requested media type should be a JSON or XML

Parameters:

types - the media types requested by the client

Returns:

true if the type is JSON, false if it is XML

Throws:

UnsupportedOperationException

getItemNames

public static List<String> getItemNames(Property... props)

Parameters:

props -

Returns:

executePredefinedStep

protected String executePredefinedStep(ItemProxy item,
                                       String postData,
                                       String contentType,
                                       String actPath,
                                       AgentProxy agent)
                                throws ObjectNotFoundException,
                                       InvalidDataException,
                                       OutcomeBuilderException,
                                       AccessRightsException,
                                       InvalidTransitionException,
                                       PersistencyException,
                                       ObjectAlreadyExistsException,
                                       InvalidCollectionModification

Parameters:

item -

postData -

types -

actPath -

agent -

Returns:

Throws:

ObjectNotFoundException

InvalidDataException

OutcomeBuilderException

AccessRightsException

InvalidTransitionException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

executeJob

protected String executeJob(ItemProxy item,
                            String postData,
                            String contentType,
                            String actPath,
                            String transition,
                            AgentProxy agent)
                     throws AccessRightsException,
                            ObjectNotFoundException,
                            PersistencyException,
                            InvalidDataException,
                            OutcomeBuilderException,
                            InvalidTransitionException,
                            ObjectAlreadyExistsException,
                            InvalidCollectionModification,
                            ScriptErrorException

Parameters:

item -

postData -

types -

actPath -

transition -

agent -

Returns:

Throws:

AccessRightsException

ObjectNotFoundException

PersistencyException

InvalidDataException

OutcomeBuilderException

InvalidTransitionException

ObjectAlreadyExistsException

InvalidCollectionModification

ScriptErrorException