org.alfresco.rest.framework.webscripts.metadata

Class WebScriptOptionsMetaData

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.rest.framework.webscripts.ApiWebScript

org.alfresco.rest.framework.webscripts.metadata.WebScriptOptionsMetaData

All Implemented Interfaces:

ResourceMetaDataWriter, org.springframework.extensions.webscripts.WebScript

public class WebScriptOptionsMetaData
extends ApiWebScript
implements ResourceMetaDataWriter

Provides general information about an Api call and its methods.

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.ApiWebScript

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

Constructor Summary

Constructors

Constructor and Description
WebScriptOptionsMetaData()

Method Summary

Modifier and Type	Method and Description
protected ResourceMetaDataWriter	chooseWriter(org.springframework.extensions.webscripts.WebScriptRequest req) Chooses the correct writer to use based on the supplied "format" param
void	execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
static Object	processResult(ResourceWithMetadata resource, Map<String,ResourceWithMetadata> apiResources) Processes the resulting resource and returns the data to be displayed
void	setLookupDictionary(ResourceLookupDictionary lookupDictionary)
void	setWriters(Map<String,ResourceMetaDataWriter> writers)
void	writeMetaData(OutputStream out, ResourceWithMetadata resource, Map<String,ResourceWithMetadata> allApiResources) Write the metadata to the OutputStream

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

Constructor Detail

WebScriptOptionsMetaData

public WebScriptOptionsMetaData()

Method Detail

setLookupDictionary

public void setLookupDictionary(ResourceLookupDictionary lookupDictionary)

execute

public void execute(Api api,
                    org.springframework.extensions.webscripts.WebScriptRequest req,
                    org.springframework.extensions.webscripts.WebScriptResponse res)
             throws IOException

Specified by:

execute in class ApiWebScript

Throws:

IOException

chooseWriter

protected ResourceMetaDataWriter chooseWriter(org.springframework.extensions.webscripts.WebScriptRequest req)

Chooses the correct writer to use based on the supplied "format" param

Parameters:

req - - the WebScriptRequest

Returns:

ResourceMetaDataWriter - a matching writer - DEFAULT is this class.

processResult

public static Object processResult(ResourceWithMetadata resource,
                                   Map<String,ResourceWithMetadata> apiResources)

Processes the resulting resource and returns the data to be displayed

Parameters:

resource - ResourceWithMetadata

Returns:

Either a ExecutionResult or a CollectionWithPagingInfo

writeMetaData

public void writeMetaData(OutputStream out,
                          ResourceWithMetadata resource,
                          Map<String,ResourceWithMetadata> allApiResources)
                   throws IOException

Description copied from interface: ResourceMetaDataWriter

Write the metadata to the OutputStream

Specified by:

writeMetaData in interface ResourceMetaDataWriter

Parameters:

out - OutputStream

resource - - the selected resource

allApiResources - - all resources for the API version

Throws:

IOException

setWriters

public void setWriters(Map<String,ResourceMetaDataWriter> writers)