org.structr.rest.resource

Class ViewFilterResource

java.lang.Object

org.structr.rest.resource.Resource

org.structr.rest.resource.WrappingResource

org.structr.rest.resource.ViewFilterResource

Direct Known Subclasses:

IdsOnlyResource

public class ViewFilterResource
extends WrappingResource

A resource constraint whose only purpose is to configure the property view. This constraint must be wrapped around another resource constraint, otherwise it will throw an IllegalPathException.

Author:

Christian Morgner

Field Summary

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

wrappedResource

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

idProperty, securityContext

Constructor Summary

Constructors

Constructor and Description
ViewFilterResource()

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.
void	configurePropertyView(Value<String> propertyView)
Result	doGet(PropertyKey sortKey, boolean sortDescending, int pageSize, int page, String offsetId)
RestMethodResult	doPost(Map<String,Object> propertySet)
String	getPropertyView()
String	getResourceSignature()

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

getEntityClass, getUriPart, isCollectionResource, isPrimitiveArray, tryCombineWith, wrapResource

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

applyDefaultSorting, buildLocationHeader, configureIdProperty, 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

Constructor Detail

ViewFilterResource

public ViewFilterResource()

Method Detail

checkAndConfigure

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

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

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

configurePropertyView

public void configurePropertyView(Value<String> propertyView)

Overrides:

configurePropertyView in class Resource

getResourceSignature

public String getResourceSignature()

Specified by:

getResourceSignature in class Resource

getPropertyView

public String getPropertyView()