Package com.axemble.vdoc.sdk.interfaces.runtime

Interface IExecutionContext.IRequest

Enclosing interface:
IExecutionContext
public static interface IExecutionContext.IRequest
The request interface.
Since:
2.1
Version:
1.0, 09/09/2009
Author:
vlygeros
See Also:

  • Method Details

    • getNativeRequest

      Object getNativeRequest()
      Gets the native request object.
      Returns:
      Returns the native request object.

    • setAttribute

      void setAttribute(String key, Object value)
      Sets an attribute.
      Parameters:
      key - The key of the attribute.
      value - The value of the attribute.

    • getAttribute

      Object getAttribute(String key)
      Gets an attribute from the request.
      Parameters:
      key - The key of the attribute to retrieve.
      Returns:
      A value associated to the attribute.

    • getAttributeNames

      Enumeration getAttributeNames()
      Gets all the attribute names.
      Returns:
      An java.util.Enumeration object.

    • getSession

      IExecutionContext.ISession getSession()
      Gets the session.
      Returns:
      A IExecutionContext.ISession object.

    • getUserAgent

      String getUserAgent()
      Gets the user agent.
      Returns:
      The user agent as a java.lang.String object.

    • getQueryString

      String getQueryString()
      Gets the requested string.
      Returns:
      The requested string as a java.lang.String object.

    • getParameterMap

      Map getParameterMap()
      Gets the parmeter map.
      Returns:
      The parameter map.

    • getParameter

      String getParameter(String key)
      Gets a parameter by its key.
      Parameters:
      key - The key of the parameter.
      Returns:
      The parameter associated with the key.

    • getParameters

      String[] getParameters(String key)
      Gets all the parameters associated with a key.
      Parameters:
      key - The key of the parameters.
      Returns:
      All the parameters associated with the key.

    • getParameterValues

      String[] getParameterValues(String key)
      Gets all the values associated with a key.
      Parameters:
      key - The key of the parameters.
      Returns:
      All the values associated with the key.

    • getCookieValue

      String getCookieValue(String name)
      Gets a cookie value
      Parameters:
      name -
      Returns:
      A java.lang.String object.

    • getRequestURI

      String getRequestURI()
      Gets the request URI.
      Returns:
      A java.lang.String object.

    • getContextPath

      String getContextPath()
      Gets the context path.
      Returns:
      A java.lang.String object.

    • getScheme

      String getScheme()
      Gets the scheme (http, https, ...).
      Returns:
      A java.lang.String object.

    • getServerName

      String getServerName()
      Gets the server name.
      Returns:
      A java.lang.String object.

    • getServerPort

      int getServerPort()
      Gets the port number.
      Returns:
      The port number.

    • getInputStream

      InputStream getInputStream() throws IOException
      Gets the input stream of the request.
      Returns:
      A InputStream object.
      Throws:
      IOException - An IO exception.

    • getResponseContentType

      String getResponseContentType()

    • getContentType

      String getContentType()

    • getScope

      String getScope()

    • setScope

      void setScope(String scope)

    • getContextKey

      String getContextKey()

    • setContextKey

      void setContextKey(String contextKey)

    • getLocale

      Locale getLocale()

    • getLocales

      Enumeration getLocales()

    • getRemoteAddr

      String getRemoteAddr()

    • getRemoteHost

      String getRemoteHost()

    • getRemoteUser

      String getRemoteUser()

    • getBaseUrl

      String getBaseUrl()
      Return base application url (ex : http://vdocservername:vdocserverport/vdocpath)
      Returns:
      base application url

    • getBaseServerUrl

      String getBaseServerUrl()
      Returns the base server url (e.g. : http://vdocservername:vdocserverport)
      Returns:
      base server url

    • getReferer

      String getReferer()

    • getHeader

      String getHeader(String key)

    • getRequestURL

      StringBuffer getRequestURL()

    • isSecure

      boolean isSecure()
      check if the connection is secure
      Returns:
      true is scheme is https