org.springframework.extensions.webscripts

Interface Description

All Superinterfaces:

BaseDescription, BaseDescriptionDocument

All Known Implementing Classes:

DescriptionImpl

public interface Description
extends BaseDescriptionDocument

Web Script Description

Author:

davidc

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Description.FormatStyle Enumeration of ways to specify format
static class	Description.Lifecycle Enumeration of lifecycle which indicates the status of this web script
static class	Description.RequiredAuthentication Enumeration of "required" Authentication level
static interface	Description.RequiredCache Caching requirements
static class	Description.RequiredTransaction Enumeration of "required" Transaction level
static interface	Description.RequiredTransactionParameters Transaction Requirements
static class	Description.TransactionCapability Enumeration of transaction capability

Method Summary

Methods

Modifier and Type	Method and Description
ArgumentTypeDescription[]	getArguments() Gets webscript argument descriptions
String	getDefaultFormat() Gets the default response format Note: the default response format is the first listed in the service description document
InputStream	getDescDocument() Gets the description xml document for this web script
String	getDescPath() Gets the path of the description xml document for this web script
Map<String,Serializable>	getExtensions() Gets web script specific extensions
Set<String>	getFamilys() Gets the family(s) of this service in the order that they are defined
Description.FormatStyle	getFormatStyle() Gets the style of Format discriminator supported by this web script
String	getKind() Gets the kind of service.
Description.Lifecycle	getLifecycle() Get the lifecycle
String	getMethod() Gets the HTTP method this service is bound to
boolean	getMultipartProcessing()
NegotiatedFormat[]	getNegotiatedFormats() Gets the formats available for negotiation
Path	getPackage() Gets the package (Path version of getScriptPath)
TypeDescription[]	getRequestTypes() Gets webscript request types
Description.RequiredAuthentication	getRequiredAuthentication() Gets the required authentication level for execution of this service
Description.RequiredCache	getRequiredCache() Gets the required level of caching
Description.RequiredTransaction	getRequiredTransaction() Gets the required transaction level
Description.RequiredTransactionParameters	getRequiredTransactionParameters() Gets the transaction parameters
TypeDescription[]	getResponseTypes() Gets webscript response types
String	getRunAs() Gets the ID of the user that the service should be run as or null if the service is to be run as the authenticated user.
String	getScriptPath() Gets the path within the store of this web script
String	getStorePath() Gets the root path of the store of this web script
String[]	getURIs() Gets the URIs this service supports
void	setMultipartProcessing(boolean multipartProcessing)

Methods inherited from interface org.springframework.extensions.webscripts.BaseDescription

getDescription, getId, getShortName

Method Detail

getStorePath

String getStorePath()

Gets the root path of the store of this web script

Specified by:

getStorePath in interface BaseDescriptionDocument

Returns:

root path of store

getScriptPath

String getScriptPath()

Gets the path within the store of this web script

Returns:

path within store

getPackage

Path getPackage()

Gets the package (Path version of getScriptPath)

getDescPath

String getDescPath()

Gets the path of the description xml document for this web script

Specified by:

getDescPath in interface BaseDescriptionDocument

Returns:

document location (path)

getDescDocument

InputStream getDescDocument()
                            throws IOException

Gets the description xml document for this web script

Specified by:

getDescDocument in interface BaseDescriptionDocument

Returns:

source document

Throws:

IOException

getKind

String getKind()

Gets the kind of service. A Web Script may explicitly define its backing-bean implementation. The backing bean implementation is identified by a Spring bean whose id is: webscript. The may be dot separated.

Returns:

the kind of service (or null, for a vanilla declarative web script)

getFamilys

Set<String> getFamilys()

Gets the family(s) of this service in the order that they are defined

getRequiredAuthentication

Description.RequiredAuthentication getRequiredAuthentication()

Gets the required authentication level for execution of this service

Returns:

the required authentication level

getRunAs

String getRunAs()

Gets the ID of the user that the service should be run as or null if the service is to be run as the authenticated user.

Returns:

a user name or null if not applicable

getRequiredTransaction

Description.RequiredTransaction getRequiredTransaction()

Gets the required transaction level

Returns:

the required transaction level

getRequiredTransactionParameters

Description.RequiredTransactionParameters getRequiredTransactionParameters()

Gets the transaction parameters

Returns:

the transaction parameters

getRequiredCache

Description.RequiredCache getRequiredCache()

Gets the required level of caching

Returns:

RequiredCache

getMethod

String getMethod()

Gets the HTTP method this service is bound to

Returns:

HTTP method

getURIs

String[] getURIs()

Gets the URIs this service supports

Returns:

array of URIs in order specified in service description document

getFormatStyle

Description.FormatStyle getFormatStyle()

Gets the style of Format discriminator supported by this web script

Returns:

format style

getDefaultFormat

String getDefaultFormat()

Gets the default response format Note: the default response format is the first listed in the service description document

Returns:

default response format (or null, if format not known until run-time)

getNegotiatedFormats

NegotiatedFormat[] getNegotiatedFormats()

Gets the formats available for negotiation

Returns:

negotiated formats

getExtensions

Map<String,Serializable> getExtensions()

Gets web script specific extensions

Returns:

map of extensions by name

getLifecycle

Description.Lifecycle getLifecycle()

Get the lifecycle

getMultipartProcessing

boolean getMultipartProcessing()

Returns:

true if automatic multipart formdata processing is enabled

setMultipartProcessing

void setMultipartProcessing(boolean multipartProcessing)

Parameters:

multipartProcessing - true if automatic multipart formdata processing is enabled

getArguments

ArgumentTypeDescription[] getArguments()

Gets webscript argument descriptions

Returns:

argument descriptions

getRequestTypes

TypeDescription[] getRequestTypes()

Gets webscript request types

Returns:

request types

getResponseTypes

TypeDescription[] getResponseTypes()

Gets webscript response types

Returns:

response types