Package org.springframework.extensions.webscripts

Interface Description

    • Method Detail

      • getStorePath

        java.lang.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

        java.lang.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

        java.lang.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

        java.io.InputStream getDescDocument()
                             throws java.io.IOException
        Gets the description xml document for this web script
        Specified by:
        getDescDocument in interface BaseDescriptionDocument
        Returns:
        source document
        Throws:
        java.io.IOException

      • getKind

        java.lang.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

        java.util.Set<java.lang.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

        java.lang.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

      • getMethod

        java.lang.String getMethod()
        Gets the HTTP method this service is bound to
        Returns:
        HTTP method

      • getURIs

        java.lang.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

        java.lang.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

        java.util.Map<java.lang.String,​java.io.Serializable> getExtensions()
        Gets web script specific extensions
        Returns:
        map of extensions by name

      • 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