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

PortletController.InvocationContextImpl - JBOSS Portal 2.4 API 英文版文档


org.jboss.portal.portlet.test
Class PortletController.InvocationContextImpl

java.lang.Object
  extended byorg.jboss.portal.portlet.impl.spi.AbstractInvocationContext
      extended byorg.jboss.portal.portlet.test.PortletController.InvocationContextImpl
All Implemented Interfaces:
InvocationContext
Direct Known Subclasses:
PortletController.ActionContextImpl, PortletController.RenderContextImpl
Enclosing class:
PortletController

protected class PortletController.InvocationContextImpl
extends AbstractInvocationContext
implements InvocationContext


Nested Class Summary
 
Nested classes inherited from class org.jboss.portal.portlet.spi.InvocationContext
InvocationContext.Scope
 
Field Summary
protected  Mode mode
           
protected  StateString navigationalState
           
protected  Portlet portlet
           
protected  ServerRequest serverRequest
           
protected  ServerResponse serverResponse
           
protected  WindowState windowState
           
 
Fields inherited from interface org.jboss.portal.portlet.spi.InvocationContext
INVOCATION_SCOPE, PRINCIPAL_SCOPE, SESSION_SCOPE
 
Constructor Summary
PortletController.InvocationContextImpl(Portlet portlet, ServerInvocation invocation, StateString navigationalState, WindowState windowState, Mode mode)
           
 
Method Summary
 java.lang.String encodeURL(PortletURL portletURL, java.lang.Boolean wantSecure, java.lang.Boolean wantAuthenticated, boolean relative)
           
 java.lang.String encodeURL(java.lang.String url)
          Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
 javax.servlet.http.HttpServletRequest getClientRequest()
          Return the client request.
 javax.servlet.http.HttpServletResponse getClientResponse()
          Return the client response.
 Mode getMode()
          Returns the mode for this invocation.
 StateString getNavigationalState()
          Returns the navigational state for this invocation.
 HTTPStreamInfo getStreamInfo()
          Return information about the underlying http wire this invocation is performed.
 WindowState getWindowState()
          Returns the window state for this invocation.
 
Methods inherited from class org.jboss.portal.portlet.impl.spi.AbstractInvocationContext
getAttribute, 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.portlet.spi.InvocationContext
getAttribute, setAttribute
 

Field Detail

portlet

protected Portlet portlet

serverRequest

protected ServerRequest serverRequest

serverResponse

protected ServerResponse serverResponse

navigationalState

protected StateString navigationalState

windowState

protected WindowState windowState

mode

protected Mode mode
Constructor Detail

PortletController.InvocationContextImpl

public PortletController.InvocationContextImpl(Portlet portlet,
                                               ServerInvocation invocation,
                                               StateString navigationalState,
                                               WindowState windowState,
                                               Mode mode)
Method Detail

getClientResponse

public javax.servlet.http.HttpServletResponse getClientResponse()
Description copied from class: AbstractInvocationContext
Return the client response.

Specified by:
getClientResponse in class AbstractInvocationContext

getClientRequest

public javax.servlet.http.HttpServletRequest getClientRequest()
Description copied from class: AbstractInvocationContext
Return the client request.

Specified by:
getClientRequest in class AbstractInvocationContext

getMode

public Mode getMode()
Description copied from interface: InvocationContext
Returns the mode for this invocation.

Specified by:
getMode in interface InvocationContext
Returns:
the mode

getWindowState

public WindowState getWindowState()
Description copied from interface: InvocationContext
Returns the window state for this invocation.

Specified by:
getWindowState in interface InvocationContext
Returns:
the window state

getNavigationalState

public StateString getNavigationalState()
Description copied from interface: InvocationContext
Returns the navigational state for this invocation.

Specified by:
getNavigationalState in interface InvocationContext
Returns:
the navigational state

getStreamInfo

public HTTPStreamInfo getStreamInfo()
Description copied from interface: InvocationContext
Return information about the underlying http wire this invocation is performed.

Specified by:
getStreamInfo in interface InvocationContext
Returns:
the stream info

encodeURL

public java.lang.String encodeURL(java.lang.String url)
Description copied from interface: InvocationContext

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Specified by:
encodeURL in interface InvocationContext
Overrides:
encodeURL in class AbstractInvocationContext

encodeURL

public java.lang.String encodeURL(PortletURL portletURL,
                                  java.lang.Boolean wantSecure,
                                  java.lang.Boolean wantAuthenticated,
                                  boolean relative)
Specified by:
encodeURL in interface InvocationContext
Parameters:
portletURL - the portlet url
wantSecure -
wantAuthenticated -
relative -
Returns:
the url