PortletInvocation - 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.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
Version:: $Revision: 5477 $
Author:: Julien Viet

Field Summary

protected PortletInvocationContext ctx
          The invocation context.

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 PortalContext portalContext
          The portal context.

static java.lang.String PORTLET_CONTEXT_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.

static Scope PRINCIPAL_SCOPE
          The portal principal scope.

static Scope REQUEST_PROPERTIES_SCOPE
          The request properties .

static Scope REQUEST_SCOPE
          The request scope.

protected RequestContext requestContext
          The request context.

static Scope RESPONSE_PROPERTIES_SCOPE
          The response properties.

protected SecurityContext securityContext
          The security context.

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.

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

EMPTY_STACK

Constructor Summary

protected PortletInvocation(PortletInvocationContext ctx)
          Create an invocation to a portlet.

Method Summary

InvocationContext getContext()
          Return the invocation context or throw IllegalStateException.

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

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

PortletInfo getInfo()


InstanceContext getInstanceContext()


PortalContext getPortalContext()


PortletInvocationContext getPortletContext()


RequestContext getRequestContext()


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 setInfo(PortletInfo info)


void setInstanceContext(InstanceContext instanceContext)


void setPortalContext(PortalContext portalContext)


void setRequestContext(RequestContext requestContext)


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, getHandler, invoke, invokeNext, removeAttribute, setAttribute, setHandler

Methods inherited from class java.lang.Object

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

Field Detail

PRINCIPAL_SCOPE

public static final Scope PRINCIPAL_SCOPE

The portal principal scope.

REQUEST_SCOPE

public static final Scope REQUEST_SCOPE

The request scope.

REQUEST_PROPERTIES_SCOPE

public static final Scope REQUEST_PROPERTIES_SCOPE

The request properties .

RESPONSE_PROPERTIES_SCOPE

public static final Scope RESPONSE_PROPERTIES_SCOPE

The response properties.

PORTLET_CONTEXT_ATTRIBUTE

public static final java.lang.String PORTLET_CONTEXT_ATTRIBUTE

The attribute name under which the portlet id 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

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.

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.

ctx

protected PortletInvocationContext ctx

The invocation context.

Constructor Detail