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
static javax.ws.rs.WebApplicationException	createWebAppException(String msg) Creates a WebApplicationException response from a simple text message.
static javax.ws.rs.WebApplicationException	createWebAppException(String msg, Exception ex, javax.ws.rs.core.Response.Status status) Creates a WebApplicationException response from a simple text message, exception and status
static javax.ws.rs.WebApplicationException	createWebAppException(String msg, javax.ws.rs.core.Response.Status status) Creates a WebApplicationException response from a simple text message and status
ArrayList<LinkedHashMap<String,Object>>	enumerate(ItemProxy item, ClusterType cluster, String uriPath, javax.ws.rs.core.UriInfo uri)
ArrayList<LinkedHashMap<String,Object>>	enumerate(ItemProxy item, String dataPath, String uriPath, javax.ws.rs.core.UriInfo uri)
protected String	executeJob(ItemProxy item, String postData, List<String> types, String actPath, String transition, AgentProxy agent)
protected String	executePredefinedStep(ItemProxy item, String postData, List<String> types, String actPath, AgentProxy agent)
protected ArrayList<LinkedHashMap<String,Object>>	getAllViewpoints(ItemProxy item, javax.ws.rs.core.UriInfo uri)
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	getOutcome(String uuid, String schema, int version, int eventId, boolean json)
protected javax.ws.rs.core.Response	getOutcomeResponse(Outcome oc, boolean json) Creates Response with without any specific header.
protected javax.ws.rs.core.Response	getOutcomeResponse(Outcome oc, Date eventDate, boolean json) Creates Response with header 'Last-Modified: '
protected javax.ws.rs.core.Response	getOutcomeResponse(Outcome oc, Event ev, boolean json)
protected static ArrayList<LinkedHashMap<String,String>>	getPropertySummary(ItemProxy item)
protected static ItemProxy	getProxy(String uuid)
javax.ws.rs.core.Response	getViewpointOutcome(String uuid, String schema, String viewName, boolean json)
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 void	makeItemDomainPathsData(ItemPath ip, Map<String,Object> jsonRoot)
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

checkAuthCookie, encryptAuthData, getAgent, getAgent, getPagedResult, getPropertiesFromQParams, 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 static ItemProxy getProxy(String uuid)

getViewpointOutcome

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

getOutcome

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

enumerate

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

enumerate

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

getAllViewpoints

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

getOutcomeResponse

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

Creates Response with without any specific header.

Parameters:

oc - the Outcome to convert

json - produce json or xml

Returns:

the ws Response

getOutcomeResponse

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

Creates Response with header 'Last-Modified: '

Parameters:

oc - the Outcome to convert

json - produce json or xml

Returns:

the ws Response

getOutcomeResponse

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

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)

createWebAppException

public static javax.ws.rs.WebApplicationException createWebAppException(String msg)

Creates a WebApplicationException response from a simple text message. The status is set to INTERNAL_SERVER_ERROR

Parameters:

msg - text message

Returns:

WebApplicationException response

createWebAppException

public static javax.ws.rs.WebApplicationException createWebAppException(String msg,
                                                                        javax.ws.rs.core.Response.Status status)

Creates a WebApplicationException response from a simple text message and status

Parameters:

msg - text message

status - HTTP status of the response

Returns:

WebApplicationException response

createWebAppException

public static javax.ws.rs.WebApplicationException createWebAppException(String msg,
                                                                        Exception ex,
                                                                        javax.ws.rs.core.Response.Status status)

Creates a WebApplicationException response from a simple text message, exception and status

Parameters:

msg - text message

ex - exception

status - HTTP status of the response

Returns:

WebApplicationException response

produceJSON

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

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

getItemNames

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

Parameters:

type -

Returns:

makeItemDomainPathsData

protected void makeItemDomainPathsData(ItemPath ip,
                                       Map<String,Object> jsonRoot)

Parameters:

ip -

jsonRoot -

executePredefinedStep

protected String executePredefinedStep(ItemProxy item,
                                       String postData,
                                       List<String> types,
                                       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,
                            List<String> types,
                            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