Package org.springframework.extensions.webscripts

Interface WebScriptRequest

All Known Subinterfaces:
WrappingWebScriptRequest
All Known Implementing Classes:
WebScriptRequestImpl, WebScriptRequestURLImpl, WebScriptServletRequest
public interface WebScriptRequest
Web Script Request
Author:
davidc

  • Method Details

    • getServiceMatch

      Match getServiceMatch()
      Gets the matching API Service for this request
      Returns:
      the service match

    • getServerPath

      String getServerPath()
      Get server portion of the request e.g. scheme://host:port
      Returns:
      server path

    • getContextPath

      String getContextPath()
      Gets the Alfresco Context Path
      Returns:
      context url e.g. /alfresco

    • getServiceContextPath

      String getServiceContextPath()
      Gets the Alfresco Web Script Context Path
      Returns:
      service url e.g. /alfresco/service

    • getServicePath

      String getServicePath()
      Gets the Alfresco Service Path
      Returns:
      service url e.g. /alfresco/service/search/keyword

    • getURL

      String getURL()
      Gets the full request URL
      Returns:
      request url e.g. /alfresco/service/search/keyword?q=term

    • getPathInfo

      String getPathInfo()
      Gets the service specific path
      Returns:
      request path e.g. /search/keyword

    • getQueryString

      String getQueryString()
      Gets the query String
      Returns:
      query string e.g. q=alfresco&format=atom

    • getParameterNames

      String[] getParameterNames()
      Gets the names of all parameters on the Url
      Returns:
      the names (empty, if none)

    • getParameter

      String getParameter(String name)
      Gets the value of the named parameter
      Parameters:
      name - parameter name
      Returns:
      parameter value (or null, if parameter does not exist)

    • getParameterValues

      String[] getParameterValues(String name)
      Gets the (array) value of the named parameter Note: An array of one item is returned when a "single value" named parameter is requested
      Parameters:
      name - parameter name
      Returns:
      array of values (or null, if parameter does not exist)

    • getHeaderNames

      String[] getHeaderNames()
      Gets the names of all headers for this request
      Returns:
      the names (empty, if none)

    • getHeader

      String getHeader(String name)
      Gets the value of the named header
      Parameters:
      name - header name
      Returns:
      header value (or null, if header does not exist)

    • getHeaderValues

      String[] getHeaderValues(String name)
      Gets the (array) value of the named header Note: An array of one item is returned when a "single value" named header is requested
      Parameters:
      name - header name
      Returns:
      array of values (or null, if header does not exist)

    • getExtensionPath

      String getExtensionPath()
      Gets the path extension beyond the path registered for this service e.g. a) service registered path = /search/engine b) request path = /search/engine/external => /external
      Returns:
      extension path

    • getContentType

      String getContentType()
      Gets the mimetype of the request
      Returns:
      request content mimetype

    • getContent

      org.springframework.extensions.surf.util.Content getContent()
      Gets the request body as content
      Returns:
      request content (or null, if none)

    • parseContent

      Object parseContent()
      Gets the request body as a parsed entity
      Returns:
      the parsed entity (or null, if no content, or the content type cannot be parsed)

    • isGuest

      boolean isGuest()
      Determine if Guest User?
      Returns:
      true => guest user

    • getFormat

      String getFormat()
      Get Requested Format
      Returns:
      content type requested

    • getFormatStyle

      Description.FormatStyle getFormatStyle()
      Get the style the Format was specified in
      Returns:
      format style (excludes any)

    • getAgent

      String getAgent()
      Get User Agent TODO: Expand on known agents
      Returns:
      MSIE / Firefox

    • getJSONCallback

      String getJSONCallback()
      Get the JSON callback method
      Returns:
      method (or null, if not specified)

    • forceSuccessStatus

      boolean forceSuccessStatus()
      Force response to return SUCCESS (200) code Note: This is to support clients who cannot support non-success codes e.g. Flash player
      Returns:
      true => force return of 200, otherwise return status explicitly set

    • getRuntime

      Runtime getRuntime()
      Gets the initiating runtime
      Returns:
      runtime that constructed this request