Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.portal.server
Interface ServerInvocationContext

All Superinterfaces:
  org.jboss.portal.common.invocation.InvocationContext

All Known Implementing Classes:
  ServerInvocationContextImpl

    public interface ServerInvocationContext

extends org.jboss.portal.common.invocation.InvocationContext

Version:
  $Revision: 8784 $
Author:
  Julien Viet

Method Summary
`org.jboss.portal.common.util.ParameterMap` | `getBodyParameterMap()` Return the parameter map for the body if the request was a POST with the content type x-www-formurlencoded otherwise return null.
`javax.servlet.http.HttpServletRequest` | `getClientRequest()` Return the request that made the connection to the server.
`javax.servlet.http.HttpServletResponse` | `getClientResponse()` Return the response that will be used by the server.
`java.lang.String` | `getMediaType()` Return the normalized media type of the request or null if none has been provided by the client.
`java.lang.String` | `getPortalContextPath()` Return the value of the portal context path for this request.
`java.lang.String` | `getPortalHost()` Return the portal host value for this request.
`java.lang.String` | `getPortalRequestPath()` Return the value of the portal request path for this request.
`org.jboss.portal.common.util.ParameterMap` | `getQueryParameterMap()` Return the parameter map decoded form the query string.
`URLContext` | `getURLContext()` Return the url context of this request.
`java.lang.String` | `renderURL(ServerURL url, URLContext context, URLFormat format)` Renders an URL.

Methods inherited from interface org.jboss.portal.common.invocation.InvocationContext
`getAttribute, getAttributeResolver, removeAttribute, setAttribute`

Method Detail

### getClientRequest

    javax.servlet.http.HttpServletRequest getClientRequest()

  Return the request that made the connection to the server.

  Returns:
    the http request.

### getClientResponse

    javax.servlet.http.HttpServletResponse getClientResponse()

  Return the response that will be used by the server.

  Returns:
    the http response

### getQueryParameterMap

    org.jboss.portal.common.util.ParameterMap getQueryParameterMap()

  Return the parameter map decoded form the query string.

### getBodyParameterMap

    org.jboss.portal.common.util.ParameterMap getBodyParameterMap()

  Return the parameter map for the body if the request was a POST with the content type x-www-formurlencoded otherwise return null.

  Returns:
    the body parameter map

### getMediaType

    java.lang.String getMediaType()

  Return the normalized media type of the request or null if none has been provided by the client.

  Returns:
    the media type

### getURLContext

    URLContext getURLContext()

  Return the url context of this request.

  Returns:
    the url context

### getPortalRequestPath

    java.lang.String getPortalRequestPath()

  Return the value of the portal request path for this request.

  Returns:
    the portal request path

### getPortalContextPath

    java.lang.String getPortalContextPath()

  Return the value of the portal context path for this request.

  Returns:
    the portal context path

### getPortalHost

    java.lang.String getPortalHost()

  Return the portal host value for this request.

  Returns:
    the portal host

### renderURL

    java.lang.String renderURL(ServerURL url,
                               URLContext context,
                               URLFormat format)

  Renders an URL.

  Parameters:
    `url` - the url structure
    `context` - the url context
    `format` - the url format
  Returns:
    the encoded url

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD