当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

ControllerPortletInvocationContext - JBOSS Portal 2.6 API 英文版文档

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.core.controller.portlet
Class ControllerPortletInvocationContext

java.lang.Object
  org.jboss.portal.common.invocation.AbstractInvocationContext
      org.jboss.portal.portlet.impl.spi.AbstractPortletInvocationContext
          org.jboss.portal.core.controller.portlet.ControllerPortletInvocationContext

All Implemented Interfaces:

InvocationContext, PortletInvocationContext

Direct Known Subclasses:

ControllerActionContext, ControllerRenderContext

---

public abstract class ControllerPortletInvocationContext

extends AbstractPortletInvocationContext

implements PortletInvocationContext

Version:

$Revision: 5064 $

Author:

Julien Viet

---

Nested Class Summary

 

Nested classes inherited from class org.jboss.portal.common.invocation.AbstractInvocationContext

 

Field Summary
protected  ControllerContext	controllerContext           .
protected  ServerInvocation	invocation           .
private  Mode	mode           .
protected  StateString	navigationalState           .
protected  PortalContext	portalContext           .
protected  RequestContext	requestContext           .
protected  SecurityContext	securityContext           .
protected  UserContext	userContext           .
private  Window	window           .
protected  WindowContext	windowContext           .
private  WindowState	windowState           .

 

Fields inherited from class org.jboss.portal.common.invocation.AbstractInvocationContext

 

Constructor Summary

ControllerPortletInvocationContext(ControllerContext controllerContext, ServerInvocation invocation, Portal portal, StateString navigationalState, Mode mode, WindowState windowState, Window window)

 

Method Summary
PortletInvocation	createInvocation()
java.lang.String	encodeURL(ControllerCommand cmd, URLContext urlContext, boolean relative)
java.lang.String	encodeURL(PortletURL portletURL, java.lang.Boolean wantSecure, java.lang.Boolean wantAuthenticated, boolean relative)
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.
protected abstract  PortletInvocation	newInvocation()

 

Methods inherited from class org.jboss.portal.portlet.impl.spi.AbstractPortletInvocationContext

encodeURL

 

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.portlet.spi.PortletInvocationContext

encodeURL

 

Methods inherited from interface org.jboss.portal.common.invocation.InvocationContext

getAttribute, getAttributeResolver, removeAttribute, setAttribute

 

Field Detail

controllerContext

protected ControllerContext controllerContext

.

---

invocation

protected ServerInvocation invocation

.

---

mode

private Mode mode

.

---

windowState

private WindowState windowState

.

---

window

private Window window

.

---

navigationalState

protected StateString navigationalState

.

---

portalContext

protected PortalContext portalContext

.

---

requestContext

protected RequestContext requestContext

.

---

securityContext

protected SecurityContext securityContext

.

---

userContext

protected UserContext userContext

.

---

windowContext

protected WindowContext windowContext

.

Constructor Detail

ControllerPortletInvocationContext

public ControllerPortletInvocationContext(ControllerContext controllerContext,
                                          ServerInvocation invocation,
                                          Portal portal,
                                          StateString navigationalState,
                                          Mode mode,
                                          WindowState windowState,
                                          Window window)

Method Detail

getClientResponse

public javax.servlet.http.HttpServletResponse getClientResponse()

Description copied from class: AbstractPortletInvocationContext

Return the client response.

Specified by:

getClientResponse in class AbstractPortletInvocationContext

---

getClientRequest

public javax.servlet.http.HttpServletRequest getClientRequest()

Description copied from class: AbstractPortletInvocationContext

Return the client request.

Specified by:

getClientRequest in class AbstractPortletInvocationContext

---

getMode

public Mode getMode()

Description copied from interface: PortletInvocationContext

Returns the mode for this invocation.

Specified by:

getMode in interface PortletInvocationContext

Returns:

the mode

---

getWindowState

public WindowState getWindowState()

Description copied from interface: PortletInvocationContext

Returns the window state for this invocation.

Specified by:

getWindowState in interface PortletInvocationContext

Returns:

the window state

---

getNavigationalState

public StateString getNavigationalState()

Description copied from interface: PortletInvocationContext

Returns the navigational state for this invocation.

Specified by:

getNavigationalState in interface PortletInvocationContext

Returns:

the navigational state

---

getStreamInfo

public HTTPStreamInfo getStreamInfo()

Description copied from interface: PortletInvocationContext

Return information about the underlying http wire this invocation is performed.

Specified by:

getStreamInfo in interface PortletInvocationContext

Returns:

the stream info

---

encodeURL

public java.lang.String encodeURL(PortletURL portletURL,
                                  java.lang.Boolean wantSecure,
                                  java.lang.Boolean wantAuthenticated,
                                  boolean relative)

Specified by:

encodeURL in interface PortletInvocationContext

Parameters:

portletURL - the portlet url

wantSecure -

wantAuthenticated -

relative -

Returns:

the url

---

createInvocation

public PortletInvocation createInvocation()

---

newInvocation

protected abstract PortletInvocation newInvocation()

---

encodeURL

public java.lang.String encodeURL(ControllerCommand cmd,
                                  URLContext urlContext,
                                  boolean relative)

---

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

---