Package org.gatein.pc.api.invocation

Class PortletInvocation

java.lang.Object
org.gatein.pc.api.invocation.PortletInvocation
Direct Known Subclasses:
ActionInvocation, EventInvocation, RenderInvocation, ResourceInvocation
public abstract class PortletInvocation extends Object
Since:
2.4
Version:
$Revision: 6765 $
Author:
Julien Viet

  • Field Details

    • attributes

      protected final AttributeResolver attributes
      .

    • publicNavigationalState

      protected Map<String,String[]> publicNavigationalState
      .

    • mode

      protected Mode mode
      .

    • windowState

      protected WindowState windowState
      .

    • target

      protected PortletContext target
      The target portlet.

    • requestAttributes

      protected Map<String,Object> requestAttributes
      The portlet request attributes.

    • ctx

      protected PortletInvocationContext ctx
      The invocation context.

    • portalContext

      protected PortalContext portalContext
      The portal context.

    • clientContext

      protected ClientContext clientContext
      The client context.

    • serverContext

      protected ServerContext serverContext
      The server 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.

    • req

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

    • resp

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

  • Constructor Details

  • Method Details

    • getContext

      public PortletInvocationContext getContext()

    • getTarget

      public PortletContext getTarget()

    • setTarget

      public void setTarget(PortletContext target)

    • getResponse

      public javax.servlet.http.HttpServletResponse getResponse()
      Returns the http servlet request.
      Returns:
      the response

    • setResponse

      public void setResponse(javax.servlet.http.HttpServletResponse dresp)
      Set the http servlet request.
      Parameters:
      dresp - the response

    • getDispatchedResponse

      public javax.servlet.http.HttpServletResponse getDispatchedResponse()
      Deprecated.
      use getResponse()
      Returns the http servlet request.
      Returns:
      the dispatched response

    • setDispatchedResponse

      public void setDispatchedResponse(javax.servlet.http.HttpServletResponse dresp)
      Deprecated.
      use setResponse(javax.servlet.http.HttpServletResponse)
      Set the http servlet request.
      Parameters:
      dresp - the dispatched response

    • getRequest

      public javax.servlet.http.HttpServletRequest getRequest()
      Returns the http servlet request.
      Returns:
      the request

    • setRequest

      public void setRequest(javax.servlet.http.HttpServletRequest dreq)
      Set the http servlet request.
      Parameters:
      dreq - the request

    • getDispatchedRequest

      public javax.servlet.http.HttpServletRequest getDispatchedRequest()
      Deprecated.
      use getRequest()
      Returns the dispatched http servlet request.
      Returns:
      the dispatched request

    • setDispatchedRequest

      public void setDispatchedRequest(javax.servlet.http.HttpServletRequest dreq)
      Deprecated.
      use setRequest(javax.servlet.http.HttpServletRequest)
      Set the dispatched http servlet request.
      Parameters:
      dreq - the dispatched request

    • getNavigationalState

      public StateString getNavigationalState()

    • setNavigationalState

      public void setNavigationalState(StateString navigationalState)

    • getPublicNavigationalState

      public Map<String,String[]> getPublicNavigationalState()

    • setPublicNavigationalState

      public void setPublicNavigationalState(Map<String,String[]> publicNavigationalState)

    • getMode

      public Mode getMode()

    • setMode

      public void setMode(Mode mode)

    • getWindowState

      public WindowState getWindowState()

    • setWindowState

      public void setWindowState(WindowState windowState)

    • getPortalContext

      public PortalContext getPortalContext()

    • setPortalContext

      public void setPortalContext(PortalContext portalContext)

    • getClientContext

      public ClientContext getClientContext()

    • setClientContext

      public void setClientContext(ClientContext clientContext)

    • getServerContext

      public ServerContext getServerContext()

    • setServerContext

      public void setServerContext(ServerContext serverContext)

    • getSecurityContext

      public SecurityContext getSecurityContext()

    • setSecurityContext

      public void setSecurityContext(SecurityContext securityContext)

    • getUserContext

      public UserContext getUserContext()

    • setUserContext

      public void setUserContext(UserContext userContext)

    • getInstanceContext

      public InstanceContext getInstanceContext()

    • setInstanceContext

      public void setInstanceContext(InstanceContext instanceContext)

    • getWindowContext

      public WindowContext getWindowContext()

    • setWindowContext

      public void setWindowContext(WindowContext windowContext)

    • getRequestAttributes

      public Map<String,Object> getRequestAttributes()

    • setRequestAttributes

      public void setRequestAttributes(Map<String,Object> requestAttributes)

    • setAttribute

      public void setAttribute(String attrKey, Object attrValue)

    • getAttribute

      public Object getAttribute(String attrKey)

    • removeAttribute

      public void removeAttribute(Object attrKey) throws IllegalArgumentException
      Throws:
      IllegalArgumentException