org.structr.rest.resource

Class TypedIdResource

java.lang.Object

org.structr.rest.resource.Resource

org.structr.rest.resource.WrappingResource

org.structr.rest.resource.FilterableResource

org.structr.rest.resource.TypedIdResource

public class TypedIdResource
extends FilterableResource

Represents a type-constrained ID match. A TypedIdResource will always result in a single element.

Author:

Christian Morgner

Field Summary

Fields

Modifier and Type	Field and Description
protected UuidResource	idResource
protected TypeResource	typeResource

Fields inherited from class org.structr.rest.resource.WrappingResource

wrappedResource

Fields inherited from class org.structr.rest.resource.Resource

idProperty, securityContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypedIdResource(SecurityContext securityContext)
	TypedIdResource(SecurityContext securityContext, UuidResource idResource, TypeResource typeResource)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAndConfigure(String part, SecurityContext securityContext, javax.servlet.http.HttpServletRequest request) Check and configure this instance with the given values.
Result	doGet(PropertyKey sortKey, boolean sortDescending, int pageSize, int page, String offsetId)
RestMethodResult	doPost(Map<String,Object> propertySet)
GraphObject	getEntity()
Class	getEntityClass()
UuidResource	getIdResource()
String	getResourceSignature()
TypeResource	getTypeResource()
String	getUriPart()
boolean	isCollectionResource()
Resource	tryCombineWith(Resource next)

Methods inherited from class org.structr.rest.resource.WrappingResource

isPrimitiveArray, wrapResource

Methods inherited from class org.structr.rest.resource.Resource

applyDefaultSorting, buildLocationHeader, configureIdProperty, configurePropertyView, createPostTransaction, doDelete, doHead, doOptions, doPut, extractDistanceSearch, extractSearchableAttributes, findPropertyKey, parseInteger, postProcessResultSet, setSecurityContext

Methods inherited from class java.lang.Object

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

Field Detail

typeResource

protected TypeResource typeResource

idResource

protected UuidResource idResource

Constructor Detail

TypedIdResource

protected TypedIdResource(SecurityContext securityContext)

TypedIdResource

public TypedIdResource(SecurityContext securityContext,
               UuidResource idResource,
               TypeResource typeResource)

Method Detail

checkAndConfigure

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

Description copied from class: Resource

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.

Specified by:

checkAndConfigure in class Resource

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

doGet

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

Specified by:

doGet in class Resource

Throws:

FrameworkException

doPost

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

Overrides:

doPost in class WrappingResource

Throws:

FrameworkException

getEntityClass

public Class getEntityClass()

Overrides:

getEntityClass in class WrappingResource

getTypeResource

public TypeResource getTypeResource()

getIdResource

public UuidResource getIdResource()

tryCombineWith

public Resource tryCombineWith(Resource next)
                        throws FrameworkException

Overrides:

tryCombineWith in class FilterableResource

Throws:

FrameworkException

getUriPart

public String getUriPart()

Overrides:

getUriPart in class WrappingResource

getResourceSignature

public String getResourceSignature()

Specified by:

getResourceSignature in class Resource

isCollectionResource

public boolean isCollectionResource()

Overrides:

isCollectionResource in class WrappingResource

getEntity

public GraphObject getEntity()
                      throws FrameworkException

Throws:

FrameworkException