PortletInvocation - JBOSS Portal 2.4 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.portlet.invocation
Class PortletInvocation

java.lang.Object
  org.jboss.portal.common.invocation.Invocation
      org.jboss.portal.portlet.invocation.PortletInvocation

Direct Known Subclasses:: ActionInvocation, RenderInvocation

public abstract class PortletInvocation
extends Invocation

Since:: 2.4

Nested Class Summary

static interface PortletInvocation.Dispatcher
          A dispatcher for the portlet invocation.

Field Summary

protected PortletInvocation.Dispatcher dispatcher
          The dispatcher called at the end of the stack.

protected javax.servlet.http.HttpServletRequest dreq
          The dispatched request.

protected javax.servlet.http.HttpServletResponse dresp
          The dispatched response.

protected PortletInfo info
          The portlet info we want to invoke.

static java.lang.String INSTANCE_ID_ATTRIBUTE
          The attribute name under which the instance id can be accessed.

protected InstanceContext instanceContext
          The instance context.

protected InvocationContext invocationContext
          The invocation context.

protected PortalContext portalContext
          The portal context.

static java.lang.String PORTLET_ID_ATTRIBUTE
          The attribute name under which the portlet id can be accessed.

static java.lang.String PORTLET_INVOKER
          The attribute name under which the registry can be accessed.

static java.lang.String PREFERENCES_ATTRIBUTE
          The attribute name under which the preferences can be accessed.

protected Properties properties
          The request properties.

protected RequestContext requestContext
          The request context.

protected Result result
          The result.

protected SecurityContext securityContext
          The security context.

static java.lang.String STATE_STORE_ATTRIBUTE
          The attribute name under which the state store can be accessed.

protected java.util.Set supportedModes
          The modes this portlet can accept.

protected java.util.Set supportedWindowStates
          The window states this portlet can accept.

protected UserContext userContext
          The user context.

protected WindowContext windowContext
          The window context.

Constructor Summary

protected PortletInvocation(InvocationContext invocationContext)
          Create an invocation to a portlet.

Method Summary

protected void dispatch()
          Deliver call to the container.

InvocationContext getContext()
          Return the invocation context.

javax.servlet.http.HttpServletRequest getDispatchedRequest()
          Return the dispatched http servlet request.

javax.servlet.http.HttpServletResponse getDispatchedResponse()
          Return the dispatched http servlet request.

PortletInvocation.Dispatcher getDispatcher()
          Return the dispatcher of this invocation.

PortletInfo getInfo()


InstanceContext getInstanceContext()


PortalContext getPortalContext()


Properties getProperties()


RequestContext getRequestContext()


Result getResult()
          Return the outcome of this request.

SecurityContext getSecurityContext()


java.util.Set getSupportedModes()


java.util.Set getSupportedWindowStates()


UserContext getUserContext()


WindowContext getWindowContext()


void setDispatchedRequest(javax.servlet.http.HttpServletRequest dreq)
          Set the dispatched http servlet request.

void setDispatchedResponse(javax.servlet.http.HttpServletResponse dresp)
          Set the dispatched http servlet request.

void setDispatcher(PortletInvocation.Dispatcher dispatcher)
          Set the dispatcher of this invocation.

void setInfo(PortletInfo info)


void setInstanceContext(InstanceContext instanceContext)


void setPortalContext(PortalContext portalContext)


void setProperties(Properties properties)


void setRequestContext(RequestContext requestContext)


void setResult(Result result)
          Set the outcome of this request.

void setSecurityContext(SecurityContext securityContext)


void setSupportedModes(java.util.Set supportedModes)


void setSupportedWindowStates(java.util.Set supportedWindowStates)


void setUserContext(UserContext userContext)


void setWindowContext(WindowContext windowContext)


Methods inherited from class org.jboss.portal.common.invocation.Invocation

getAttribute, invoke, invokeNext, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PORTLET_ID_ATTRIBUTE

public static final java.lang.String PORTLET_ID_ATTRIBUTE

The attribute name under which the portlet id can be accessed.

See Also:: Constant Field Values

STATE_STORE_ATTRIBUTE

public static final java.lang.String STATE_STORE_ATTRIBUTE

The attribute name under which the state store can be accessed.

See Also:: Constant Field Values

PORTLET_INVOKER

public static final java.lang.String PORTLET_INVOKER

The attribute name under which the registry can be accessed.

See Also:: Constant Field Values

PREFERENCES_ATTRIBUTE

public static final java.lang.String PREFERENCES_ATTRIBUTE

The attribute name under which the preferences can be accessed.

See Also:: Constant Field Values

INSTANCE_ID_ATTRIBUTE

public static final java.lang.String INSTANCE_ID_ATTRIBUTE

The attribute name under which the instance id can be accessed.

See Also:: Constant Field Values

invocationContext

protected InvocationContext invocationContext

The invocation context.

portalContext

protected PortalContext portalContext

The portal context.

requestContext

protected RequestContext requestContext

The request context.

securityContext

protected SecurityContext securityContext

The security context.

userContext

protected UserContext userContext

The user context.

instanceContext

protected InstanceContext instanceContext

The instance context.

windowContext

protected WindowContext windowContext

The window context.

properties

protected Properties properties

The request properties.

info

protected PortletInfo info

The portlet info we want to invoke.

supportedWindowStates

protected java.util.Set supportedWindowStates

The window states this portlet can accept.

supportedModes

protected java.util.Set supportedModes

The modes this portlet can accept.

dreq

protected javax.servlet.http.HttpServletRequest dreq

The dispatched request.

dresp

protected javax.servlet.http.HttpServletResponse dresp

The dispatched response.

dispatcher

protected PortletInvocation.Dispatcher dispatcher

The dispatcher called at the end of the stack.

result

protected Result result

The result.

Constructor Detail