org.alfresco.rest.framework.webscripts

Class ResourceWebScriptHelper

java.lang.Object

org.alfresco.rest.framework.webscripts.ResourceWebScriptHelper

public class ResourceWebScriptHelper
extends Object

Helps a Webscript with various tasks

Author:

Gethin James

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	KNOWN_PARAMS
static String	PARAM_FILTER_PROPS
static String	PARAM_ORDERBY
static String	PARAM_PAGING_MAX
static String	PARAM_PAGING_SKIP
static String	PARAM_RELATIONS
static String	PARAM_SELECT
static String	PARAM_WHERE

Constructor Summary

Constructors

Constructor and Description
ResourceWebScriptHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	extractJsonContent(org.springframework.extensions.webscripts.WebScriptRequest req, JacksonHelper jsonHelper, Class<T> requiredType) Extracts the body contents from the request
static <T> List<T>	extractJsonContentAsList(org.springframework.extensions.webscripts.WebScriptRequest req, JacksonHelper jsonHelper, Class<T> requiredType) Extracts the body contents from the request as a List, the JSON can be an array or just a single value without the [] symbols
static Paging	findPaging(org.springframework.extensions.webscripts.WebScriptRequest req) Find paging setings based on the request parameters.
static BeanPropertiesFilter	getFilter(String filterParams) Takes the web request and looks for a "filter" parameter Parses the parameter and produces a list of bean properties to use as a filter A SimpleBeanPropertyFilter it returned that uses the properties If no filter param is set then a default BeanFilter is returned that will never filter properties (ie.
static Params.RecognizedParams	getRecognizedParams(org.springframework.extensions.webscripts.WebScriptRequest req) Finds the formal set of params that any rest service could potentially have passed in as request params
static Map<String,BeanPropertiesFilter>	getRelationFilter(String filterParams) Takes the web request and looks for a "relations" parameter Parses the parameter and produces a list of bean properties to use as a filter A SimpleBeanPropertiesFilter it returned that uses the properties If no filter param is set then a default BeanFilter is returned that will never filter properties (ie.
static Map<String,String[]>	getRequestParameters(org.springframework.extensions.webscripts.WebScriptRequest req) Finds all request parameters that aren't already know about (eg.
static List<String>	getSelectClause(String selectParam) Takes the "select" parameter and turns it into a List property names
static List<SortColumn>	getSort(String sortParams) Takes the Sort parameter as a String and parses it into a List of SortColumn objects.
static Query	getWhereClause(String whereParam) Takes the "where" parameter and turns it into a Java Object that can be used for querying
Object	postProcessResponse(Api api, String entityCollectionName, Params params, Object objectToWrap) Looks at the object passed in and recursively expands any @EmbeddedEntityResource annotations or related relationship.
void	setExecutor(ActionExecutor executor)
void	setLocator(ResourceLocator locator)
static void	setUniqueId(Object theObj, String uniqueId) Set the id of theObj to the uniqueId.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_RELATIONS

public static final String PARAM_RELATIONS

See Also:

Constant Field Values

PARAM_FILTER_PROPS

public static final String PARAM_FILTER_PROPS

See Also:

Constant Field Values

PARAM_PAGING_SKIP

public static final String PARAM_PAGING_SKIP

See Also:

Constant Field Values

PARAM_PAGING_MAX

public static final String PARAM_PAGING_MAX

See Also:

Constant Field Values

PARAM_ORDERBY

public static final String PARAM_ORDERBY

See Also:

Constant Field Values

PARAM_WHERE

public static final String PARAM_WHERE

See Also:

Constant Field Values

PARAM_SELECT

public static final String PARAM_SELECT

See Also:

Constant Field Values

KNOWN_PARAMS

public static final List<String> KNOWN_PARAMS

Constructor Detail

ResourceWebScriptHelper

public ResourceWebScriptHelper()

Method Detail

getFilter

public static BeanPropertiesFilter getFilter(String filterParams)

Takes the web request and looks for a "filter" parameter Parses the parameter and produces a list of bean properties to use as a filter A SimpleBeanPropertyFilter it returned that uses the properties If no filter param is set then a default BeanFilter is returned that will never filter properties (ie. Returns all bean properties).

Parameters:

req -

Returns:

BeanPropertyFilter - if no parameter then returns a new ReturnAllBeanProperties class

getRelationFilter

public static Map<String,BeanPropertiesFilter> getRelationFilter(String filterParams)

Takes the web request and looks for a "relations" parameter Parses the parameter and produces a list of bean properties to use as a filter A SimpleBeanPropertiesFilter it returned that uses the properties If no filter param is set then a default BeanFilter is returned that will never filter properties (ie. Returns all bean properties).

Parameters:

req -

Returns:

BeanPropertiesFilter - if no parameter then returns a new ReturnAllBeanProperties class

getSelectClause

public static List<String> getSelectClause(String selectParam)
                                    throws InvalidArgumentException

Takes the "select" parameter and turns it into a List property names

Parameters:

selectParam -

Returns:

List bean property names potentially using JSON Pointer syntax

Throws:

InvalidArgumentException

getWhereClause

public static Query getWhereClause(String whereParam)
                            throws InvalidQueryException

Takes the "where" parameter and turns it into a Java Object that can be used for querying

Parameters:

whereParam -

Returns:

Query a parsed version of the where clause, represented in Java

Throws:

InvalidQueryException

getSort

public static List<SortColumn> getSort(String sortParams)

Takes the Sort parameter as a String and parses it into a List of SortColumn objects. The format is a comma seperated list of "columnName sortDirection", e.g. "name DESC, age ASC". It is not case sensitive and the sort direction is optional It default to sort ASCENDING.

Parameters:

sortParams - - String passed in on the request

Returns:

List - the sort columns or an empty list if the params were invalid.

extractJsonContent

public static <T> T extractJsonContent(org.springframework.extensions.webscripts.WebScriptRequest req,
                       JacksonHelper jsonHelper,
                       Class<T> requiredType)

Extracts the body contents from the request

Parameters:

req - the request

jsonHelper - Jackson Helper

requiredType - the type to return

Returns:

the Object in the required type

extractJsonContentAsList

public static <T> List<T> extractJsonContentAsList(org.springframework.extensions.webscripts.WebScriptRequest req,
                                   JacksonHelper jsonHelper,
                                   Class<T> requiredType)

Extracts the body contents from the request as a List, the JSON can be an array or just a single value without the [] symbols

Parameters:

req - the request

jsonHelper - Jackson Helper

requiredType - the type to return (without the List param)

Returns:

A List of "Object" as the required type

setUniqueId

public static void setUniqueId(Object theObj,
               String uniqueId)

Set the id of theObj to the uniqueId. Attempts to find a set method and invoke it. If it fails it just swallows the exceptions and doesn't throw them further.

Parameters:

theObj -

uniqueId -

postProcessResponse

public Object postProcessResponse(Api api,
                         String entityCollectionName,
                         Params params,
                         Object objectToWrap)

Looks at the object passed in and recursively expands any @EmbeddedEntityResource annotations or related relationship.

Parameters:

objectToWrap -

result -

Returns:

Object - Either ExecutionResult or CollectionWithPagingInfo

getRequestParameters

public static Map<String,String[]> getRequestParameters(org.springframework.extensions.webscripts.WebScriptRequest req)

Finds all request parameters that aren't already know about (eg. not paging or filter params) and returns them for use.

Parameters:

req - - the WebScriptRequest object

Returns:

Map the request parameters

getRecognizedParams

public static Params.RecognizedParams getRecognizedParams(org.springframework.extensions.webscripts.WebScriptRequest req)

Finds the formal set of params that any rest service could potentially have passed in as request params

Parameters:

req - WebScriptRequest

Returns:

RecognizedParams a POJO containing the params for use with the Params objects

findPaging

public static Paging findPaging(org.springframework.extensions.webscripts.WebScriptRequest req)

Find paging setings based on the request parameters.

Parameters:

req -

Returns:

Paging

setLocator

public void setLocator(ResourceLocator locator)

setExecutor

public void setExecutor(ActionExecutor executor)