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
-
-
Field Summary
-
Fields inherited from class org.alfresco.rest.framework.webscripts.ApiWebScript
assistant, encryptTempFiles, maxContentSize, memoryThreshold, responseStreamFactory, streamFactory, tempDirectoryName, transactionService
-
-
Constructor Summary
Constructors Constructor Description WebScriptOptionsMetaData()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ResourceMetaDataWriter
chooseWriter(org.springframework.extensions.webscripts.WebScriptRequest req)
Chooses the correct writer to use based on the supplied "format" paramvoid
execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
static java.lang.Object
processResult(ResourceWithMetadata resource, java.util.Map<java.lang.String,ResourceWithMetadata> apiResources)
Processes the resulting resource and returns the data to be displayedvoid
setLookupDictionary(ResourceLookupDictionary lookupDictionary)
void
setWriters(java.util.Map<java.lang.String,ResourceMetaDataWriter> writers)
void
writeMetaData(java.io.OutputStream out, ResourceWithMetadata resource, java.util.Map<java.lang.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
-
-
-
-
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 java.io.IOException
- Specified by:
execute
in classApiWebScript
- Throws:
java.io.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 java.lang.Object processResult(ResourceWithMetadata resource, java.util.Map<java.lang.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(java.io.OutputStream out, ResourceWithMetadata resource, java.util.Map<java.lang.String,ResourceWithMetadata> allApiResources) throws java.io.IOException
Description copied from interface:ResourceMetaDataWriter
Write the metadata to the OutputStream- Specified by:
writeMetaData
in interfaceResourceMetaDataWriter
- Parameters:
out
- OutputStreamresource
- - the selected resourceallApiResources
- - all resources for the API version- Throws:
java.io.IOException
-
setWriters
public void setWriters(java.util.Map<java.lang.String,ResourceMetaDataWriter> writers)
-
-