站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

ServerInvocationContextImpl - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.server.impl
Class ServerInvocationContextImpl

java.lang.Object
  extended byorg.jboss.portal.common.invocation.AbstractInvocationContext
      extended byorg.jboss.portal.server.impl.ServerInvocationContextImpl
All Implemented Interfaces:
InvocationContext, ServerInvocationContext

public class ServerInvocationContextImpl
extends AbstractInvocationContext
implements ServerInvocationContext

Version:
$Revision: 1.1 $
Author:
Julien Viet

Nested Class Summary
 
Nested classes inherited from class org.jboss.portal.common.invocation.AbstractInvocationContext
 
Field Summary
private  java.util.Map bodyParameterMap
          The body parameter map or null.
private  java.lang.String mediaType
          .
private  java.lang.String portalContextPath
          The portal context path.
private  java.lang.String portalRequestPath
          The portal request path.
private  java.util.Map queryParameterMap
          The query parameter map.
private  javax.servlet.http.HttpServletRequest req
          The client request.
private  javax.servlet.http.HttpServletResponse resp
          The client response.
private  URLContext urlContext
          The url context.
 
Fields inherited from class org.jboss.portal.common.invocation.AbstractInvocationContext
 
Constructor Summary
ServerInvocationContextImpl(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, java.lang.String portalRequestPath, java.lang.String portalContextPath, java.util.Map queryParameterMap, java.util.Map bodyParameterMap, URLContext urlContext, java.lang.String mediaType)
           
 
Method Summary
 java.lang.String encodeURL(ServerURL url, URLContext context, URLFormat format)
           
 java.util.Map 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()
          The original servlet response.
 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 getPortalRequestPath()
          Return the value of the portal request path for this request.
 java.util.Map getQueryParameterMap()
          Return the parameter map decoded form the query string.
 URLContext getURLContext()
          Return the url context of this request.
 
Methods inherited from class org.jboss.portal.common.invocation.AbstractInvocationContext
addResolver, addResolver, getAttribute, getAttributeResolver, removeAttribute, setAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jboss.portal.common.invocation.InvocationContext
getAttribute, getAttributeResolver, removeAttribute, setAttribute
 

Field Detail

req

private final javax.servlet.http.HttpServletRequest req
The client request.


resp

private final javax.servlet.http.HttpServletResponse resp
The client response.


portalContextPath

private java.lang.String portalContextPath
The portal context path.


portalRequestPath

private java.lang.String portalRequestPath
The portal request path.


mediaType

private java.lang.String mediaType
.


queryParameterMap

private java.util.Map queryParameterMap
The query parameter map.


bodyParameterMap

private java.util.Map bodyParameterMap
The body parameter map or null.


urlContext

private URLContext urlContext
The url context.

Constructor Detail

ServerInvocationContextImpl

public ServerInvocationContextImpl(javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.http.HttpServletResponse resp,
                                   java.lang.String portalRequestPath,
                                   java.lang.String portalContextPath,
                                   java.util.Map queryParameterMap,
                                   java.util.Map bodyParameterMap,
                                   URLContext urlContext,
                                   java.lang.String mediaType)
Method Detail

getClientRequest

public javax.servlet.http.HttpServletRequest getClientRequest()
Description copied from interface: ServerInvocationContext
Return the request that made the connection to the server.

Specified by:
getClientRequest in interface ServerInvocationContext

getClientResponse

public javax.servlet.http.HttpServletResponse getClientResponse()
Description copied from interface: ServerInvocationContext
The original servlet response.

Specified by:
getClientResponse in interface ServerInvocationContext
Returns:
the http response

getMediaType

public java.lang.String getMediaType()
Description copied from interface: ServerInvocationContext
Return the normalized media type of the request or null if none has been provided by the client.

Specified by:
getMediaType in interface ServerInvocationContext

getURLContext

public URLContext getURLContext()
Description copied from interface: ServerInvocationContext
Return the url context of this request.

Specified by:
getURLContext in interface ServerInvocationContext

getQueryParameterMap

public java.util.Map getQueryParameterMap()
Description copied from interface: ServerInvocationContext
Return the parameter map decoded form the query string.

Specified by:
getQueryParameterMap in interface ServerInvocationContext

getBodyParameterMap

public java.util.Map getBodyParameterMap()
Description copied from interface: ServerInvocationContext
Return the parameter map for the body if the request was a POST with the content type x-www-formurlencoded otherwise return null.

Specified by:
getBodyParameterMap in interface ServerInvocationContext

getPortalRequestPath

public java.lang.String getPortalRequestPath()
Description copied from interface: ServerInvocationContext
Return the value of the portal request path for this request.

Specified by:
getPortalRequestPath in interface ServerInvocationContext

getPortalContextPath

public java.lang.String getPortalContextPath()
Description copied from interface: ServerInvocationContext
Return the value of the portal context path for this request.

Specified by:
getPortalContextPath in interface ServerInvocationContext

encodeURL

public java.lang.String encodeURL(ServerURL url,
                                  URLContext context,
                                  URLFormat format)
Specified by:
encodeURL in interface ServerInvocationContext
Parameters:
url -
context -
format -
Returns:
the encoded url