org.jboss.portal.core.controller
Class ControllerContext

java.lang.Object
  extended by org.jboss.portal.common.invocation.AbstractInvocationContext
      extended by org.jboss.portal.core.controller.ControllerContext
All Implemented Interfaces:
InvocationContext

public class ControllerContext
extends AbstractInvocationContext

The context of the controller.

Version:
$Revision: 7395 $
Author:
Julien Viet

Field Summary
static int AJAX_TYPE
          .
static int CLASSIC_TYPE
          .
 
Constructor Summary
ControllerContext(ServerInvocation serverInvocation, Controller controller)
           
 
Method Summary
 ControllerResponse execute(ControllerCommand command)
           
 Controller getController()
           
 int getDepth()
           
 ControllerRequestDispatcher getRequestDispatcher(java.lang.String contextPath, java.lang.String path)
           
 ServerInvocation getServerInvocation()
           
 int getType()
           
 User getUser()
           
 java.util.Map getUserProfile()
           
 java.lang.String renderURL(ControllerCommand cmd, URLContext urlContext, URLFormat urlFormat)
          Render the command as an URL or return null if it is not possible.
 
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
 

Field Detail

CLASSIC_TYPE

public static final int CLASSIC_TYPE
.

See Also:
Constant Field Values

AJAX_TYPE

public static final int AJAX_TYPE
.

See Also:
Constant Field Values
Constructor Detail

ControllerContext

public ControllerContext(ServerInvocation serverInvocation,
                         Controller controller)
Method Detail

execute

public ControllerResponse execute(ControllerCommand command)
                           throws ControllerException,
                                  InvocationException
Throws:
ControllerException
InvocationException

getType

public int getType()

getDepth

public int getDepth()

renderURL

public java.lang.String renderURL(ControllerCommand cmd,
                                  URLContext urlContext,
                                  URLFormat urlFormat)
Render the command as an URL or return null if it is not possible.

Parameters:
cmd - the command to render
urlContext - the url context
urlFormat - the url format
Returns:
the URL as a string or null

getServerInvocation

public ServerInvocation getServerInvocation()

getController

public Controller getController()

getUser

public User getUser()

getUserProfile

public java.util.Map getUserProfile()

getRequestDispatcher

public ControllerRequestDispatcher getRequestDispatcher(java.lang.String contextPath,
                                                        java.lang.String path)