org.structr.rest.resource

Class MaintenanceResource

java.lang.Object

org.structr.rest.resource.Resource

org.structr.rest.resource.MaintenanceResource

public class MaintenanceResource
extends Resource

A resource constraint that allows to execute maintenance tasks via REST API.

Author:

Christian Morgner

Field Summary

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

idProperty, securityContext

Constructor Summary

Constructors

Constructor and Description
MaintenanceResource()

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.
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.
Result	doGet(PropertyKey sortKey, boolean sortDescending, int pageSize, int page, String offsetId)
RestMethodResult	doPost(Map<String,Object> propertySet)
RestMethodResult	doPut(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, doDelete, doHead, doOptions, 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

MaintenanceResource

public MaintenanceResource()

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

doPut

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

Overrides:

doPut 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

createPostTransaction

public boolean createPostTransaction()

Description copied from class: Resource

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.

Overrides:

createPostTransaction in class Resource

Returns:

whether to create transaction around the doPost() method

getEntityClass

public Class getEntityClass()

Specified by:

getEntityClass in class Resource

getUriPart

public String getUriPart()

Specified by:

getUriPart in class Resource

isCollectionResource

public boolean isCollectionResource()

Specified by:

isCollectionResource in class Resource

getResourceSignature

public String getResourceSignature()

Specified by:

getResourceSignature in class Resource