org.structr.rest.resource

Class Resource

java.lang.Object

org.structr.rest.resource.Resource

Direct Known Subclasses:

CypherQueryResource, MaintenanceParameterResource, MaintenanceResource, SchemaResource, SchemaTypeResource, WrappingResource

public abstract class Resource
extends Object

Base class for all resource constraints. Constraints can be combined with succeeding constraints to avoid unneccesary evaluation.

Author:

Christian Morgner

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyKey	idProperty
protected SecurityContext	securityContext

Constructor Summary

Constructors

Constructor and Description
Resource()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyDefaultSorting(List<? extends GraphObject> list, PropertyKey sortKey, boolean sortDescending)
protected String	buildLocationHeader(GraphObject newObject)
abstract boolean	checkAndConfigure(String part, SecurityContext securityContext, javax.servlet.http.HttpServletRequest request) Check and configure this instance with the given values.
void	configureIdProperty(PropertyKey idProperty)
void	configurePropertyView(Value<String> propertyView)
boolean	createPostTransaction() Override this method in your resource implementation and return false to prevent the creation of an encosing transaction context in your doPost() method.
RestMethodResult	doDelete()
abstract Result	doGet(PropertyKey sortKey, boolean sortDescending, int pageSize, int page, String offsetId)
RestMethodResult	doHead()
RestMethodResult	doOptions()
abstract RestMethodResult	doPost(Map<String,Object> propertySet)
RestMethodResult	doPut(Map<String,Object> propertySet)
protected void	extractDistanceSearch(javax.servlet.http.HttpServletRequest request, Query query)
protected void	extractSearchableAttributes(SecurityContext securityContext, Class type, javax.servlet.http.HttpServletRequest request, Query query)
protected PropertyKey	findPropertyKey(TypedIdResource typedIdResource, TypeResource typeResource)
abstract Class<? extends GraphObject>	getEntityClass()
abstract String	getResourceSignature()
abstract String	getUriPart()
abstract boolean	isCollectionResource()
boolean	isPrimitiveArray()
protected static int	parseInteger(Object source)
void	postProcessResultSet(Result result)
void	setSecurityContext(SecurityContext securityContext)
abstract Resource	tryCombineWith(Resource next)

Methods inherited from class java.lang.Object

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

Field Detail

securityContext

protected SecurityContext securityContext

idProperty

protected PropertyKey idProperty

Constructor Detail

Resource

public Resource()

Method Detail

tryCombineWith

public abstract Resource tryCombineWith(Resource next)
                                 throws FrameworkException

Throws:

FrameworkException

checkAndConfigure

public abstract boolean checkAndConfigure(String part,
                        SecurityContext securityContext,
                        javax.servlet.http.HttpServletRequest request)
                                   throws FrameworkException

Check and configure this instance with the given values. Please note that you need to set the security context of your class in this method.

Parameters:

part - the uri part that matched this resource

securityContext - the security context of the current request

request - the current request

Returns:

whether this resource accepts the given uri part

Throws:

FrameworkException

getUriPart

public abstract String getUriPart()

getEntityClass

public abstract Class<? extends GraphObject> getEntityClass()

getResourceSignature

public abstract String getResourceSignature()

isCollectionResource

public abstract boolean isCollectionResource()
                                      throws FrameworkException

Throws:

FrameworkException

doGet

public abstract Result doGet(PropertyKey sortKey,
           boolean sortDescending,
           int pageSize,
           int page,
           String offsetId)
                      throws FrameworkException

Throws:

FrameworkException

doPost

public abstract RestMethodResult doPost(Map<String,Object> propertySet)
                                 throws FrameworkException

Throws:

FrameworkException

doHead

public RestMethodResult doHead()
                        throws FrameworkException

Throws:

FrameworkException

doOptions

public RestMethodResult doOptions()
                           throws FrameworkException

Throws:

FrameworkException

doDelete

public RestMethodResult doDelete()
                          throws FrameworkException

Throws:

FrameworkException

doPut

public RestMethodResult doPut(Map<String,Object> propertySet)
                       throws FrameworkException

Throws:

FrameworkException

configurePropertyView

public void configurePropertyView(Value<String> propertyView)

Parameters:

propertyView -

configureIdProperty

public void configureIdProperty(PropertyKey idProperty)

postProcessResultSet

public void postProcessResultSet(Result result)

isPrimitiveArray

public boolean isPrimitiveArray()

setSecurityContext

public void setSecurityContext(SecurityContext securityContext)

createPostTransaction

public boolean createPostTransaction()

Override this method in your resource implementation and return false to prevent the creation of an encosing transaction context in your doPost() method. Default: true.

Returns:

whether to create transaction around the doPost() method

findPropertyKey

protected PropertyKey findPropertyKey(TypedIdResource typedIdResource,
                          TypeResource typeResource)

buildLocationHeader

protected String buildLocationHeader(GraphObject newObject)

applyDefaultSorting

protected void applyDefaultSorting(List<? extends GraphObject> list,
                       PropertyKey sortKey,
                       boolean sortDescending)

extractDistanceSearch

protected void extractDistanceSearch(javax.servlet.http.HttpServletRequest request,
                         Query query)

extractSearchableAttributes

protected void extractSearchableAttributes(SecurityContext securityContext,
                               Class type,
                               javax.servlet.http.HttpServletRequest request,
                               Query query)
                                    throws FrameworkException

Throws:

FrameworkException

parseInteger

protected static int parseInteger(Object source)