Package org.alfresco.rest.framework.webscripts

Class ResourceWebScriptDelete

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.rest.framework.webscripts.ApiWebScript

org.alfresco.rest.framework.webscripts.AbstractResourceWebScript

org.alfresco.rest.framework.webscripts.ResourceWebScriptDelete

All Implemented Interfaces:

HttpMethodSupport, ActionExecutor, RecognizedParamsExtractor, ResponseWriter, ParamsExtractor, org.springframework.extensions.webscripts.WebScript

public class ResourceWebScriptDelete
extends AbstractResourceWebScript
implements ParamsExtractor, RecognizedParamsExtractor

Handles the HTTP DELETE for a Resource

Author:

Gethin James

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields inherited from class org.alfresco.rest.framework.webscripts.AbstractResourceWebScript

helper, locator

Fields inherited from class org.alfresco.rest.framework.webscripts.ApiWebScript

assistant, encryptTempFiles, maxContentSize, memoryThreshold, streamFactory, tempDirectoryName, transactionService

Fields inherited from interface org.alfresco.rest.framework.tools.RecognizedParamsExtractor

KNOWN_PARAMS, PARAM_FILTER_FIELDS, PARAM_FILTER_PROPERTIES, PARAM_INCLUDE, PARAM_INCLUDE_SOURCE_ENTITY, PARAM_ORDERBY, PARAM_PAGING_MAX, PARAM_PAGING_SKIP, PARAM_RELATIONS, PARAM_SELECT, PARAM_WHERE

Fields inherited from interface org.alfresco.rest.framework.tools.ResponseWriter

CACHE_NEVER, DEFAULT_JSON_CONTENT, DEFAULT_SUCCESS, UTF8

Constructor Summary

Constructors

Constructor	Description
ResourceWebScriptDelete()

Method Summary

Modifier and Type	Method	Description
Void	execute(ResourceWithMetadata resource, Params params, org.springframework.extensions.webscripts.WebScriptResponse res, boolean isReadOnly)
Object	executeAction(ResourceWithMetadata resource, Params params, WithResponse withResponse)	Executes the action on the resource
Params	extractParams(ResourceMetadata resourceMeta, org.springframework.extensions.webscripts.WebScriptRequest req)

Methods inherited from class org.alfresco.rest.framework.webscripts.AbstractResourceWebScript

execute, getHttpMethod, getTransactionHelper, resetRequest, setHelper, setHttpMethod, setLocator, setParamsExtractor, setStreamer, streamResponse

Methods inherited from class org.alfresco.rest.framework.webscripts.ApiWebScript

execute, getRequest, getResponse, init, setAssistant, setEncryptTempFiles, setMaxContentSize, setMemoryThreshold, setStreamFactory, setTempDirectoryName, setTransactionService

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.rest.framework.core.HttpMethodSupport

getHttpMethod

Methods inherited from interface org.alfresco.rest.framework.tools.RecognizedParamsExtractor

findPaging, getClause, getFilter, getFilter, getIncludeClause, getPaging, getRecognizedParams, getRelationFilter, getRequestParameters, getSelectClause, getSort, getWhereClause, rpeLogger

Methods inherited from interface org.alfresco.rest.framework.tools.ResponseWriter

renderErrorResponse, renderException, renderJsonResponse, resWriterLogger, setContentInfoOnResponse, setResponse, setResponse

Constructor Details

ResourceWebScriptDelete

public ResourceWebScriptDelete()

Method Details

extractParams

public Params extractParams(ResourceMetadata resourceMeta,
 org.springframework.extensions.webscripts.WebScriptRequest req)

Specified by:

extractParams in interface ParamsExtractor

executeAction

public Object executeAction(ResourceWithMetadata resource,
 Params params,
 WithResponse withResponse)

Executes the action on the resource

Specified by:

executeAction in interface ActionExecutor

Parameters:

resource - ResourceWithMetadata

params - parameters to use

Returns:

anObject the result of the execute

execute

public Void execute(ResourceWithMetadata resource,
 Params params,
 org.springframework.extensions.webscripts.WebScriptResponse res,
 boolean isReadOnly)

Overrides:

execute in class AbstractResourceWebScript