org.structr.rest.resource

Class SchemaResource

java.lang.Object

org.structr.rest.resource.Resource

org.structr.rest.resource.SchemaResource

public class SchemaResource
extends Resource

Author:

Christian Morgner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaResource.UriPart

Field Summary

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

idProperty, securityContext

Constructor Summary

Constructors

Constructor and Description
SchemaResource()

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)
Class	getEntityClass()
String	getResourceSignature()
String	getUriPart()
boolean	isCollectionResource()
Resource	tryCombineWith(Resource next)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaResource

public SchemaResource()

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

Specified by:

doPost in class Resource

Throws:

FrameworkException

tryCombineWith

public Resource tryCombineWith(Resource next)
                        throws FrameworkException

Specified by:

tryCombineWith in class Resource

Throws:

FrameworkException

getUriPart

public String getUriPart()

Specified by:

getUriPart in class Resource

getEntityClass

public Class getEntityClass()

Specified by:

getEntityClass in class Resource

getResourceSignature

public String getResourceSignature()

Specified by:

getResourceSignature in class Resource

isCollectionResource

public boolean isCollectionResource()
                             throws FrameworkException

Specified by:

isCollectionResource in class Resource

Throws:

FrameworkException