org.jboss.portal.core.controller
Class ControllerCommand

java.lang.Object
  org.jboss.portal.common.invocation.Invocation
      org.jboss.portal.core.controller.ControllerCommand

Direct Known Subclasses:

PortalObjectCommand, PortletInstanceCommand, SignOutCommand, StreamContentCommand

public abstract class ControllerCommand
extends org.jboss.portal.common.invocation.Invocation

A controller command.

Version:

$Revision: 8786 $

Author:

Julien Viet

Field Summary

protected ControllerContext	context The context of the command.
protected static org.jboss.logging.Logger	log .
static org.jboss.portal.common.invocation.Scope	NAVIGATIONAL_STATE_SCOPE .
static org.jboss.portal.common.invocation.Scope	PRINCIPAL_SCOPE .
static org.jboss.portal.common.invocation.Scope	REQUEST_SCOPE .
static org.jboss.portal.common.invocation.Scope	SESSION_SCOPE .

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

EMPTY_STACK

Constructor Summary

protected

ControllerCommand()

Method Summary

void	acquireResources()
protected void	create()
void	createContext(ControllerContext context) Contextualize the command.
protected void	destroy()
void	destroyContext() Destroy state after invocation.
void	enforceSecurity(PortalAuthorizationManager pam) Enforce the security on this command.
abstract ControllerResponse	execute() Execute the command.
org.jboss.portal.common.invocation.InvocationContext	getContext()
ControllerContext	getControllerContext()
abstract CommandInfo	getInfo() Return the meta data of this command.
void	releaseResources()
static void	rethrow(java.lang.Exception e)

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 org.jboss.portal.common.invocation.Scope PRINCIPAL_SCOPE

.

SESSION_SCOPE

public static final org.jboss.portal.common.invocation.Scope SESSION_SCOPE

.

REQUEST_SCOPE

public static final org.jboss.portal.common.invocation.Scope REQUEST_SCOPE

.

NAVIGATIONAL_STATE_SCOPE

public static final org.jboss.portal.common.invocation.Scope NAVIGATIONAL_STATE_SCOPE

.

log

protected static org.jboss.logging.Logger log

.

context

protected ControllerContext context

The context of the command.

Constructor Detail

ControllerCommand

protected ControllerCommand()

Method Detail

getInfo

public abstract CommandInfo getInfo()

Return the meta data of this command.

getContext

public final org.jboss.portal.common.invocation.InvocationContext getContext()

Specified by:

getContext in class org.jboss.portal.common.invocation.Invocation

getControllerContext

public final ControllerContext getControllerContext()

enforceSecurity

public void enforceSecurity(PortalAuthorizationManager pam)
                     throws SecurityException

Enforce the security on this command.

Throws:

PortalSecurityException

SecurityException

acquireResources

public void acquireResources()
                      throws NoSuchResourceException

Throws:

NoSuchResourceException

releaseResources

public void releaseResources()

createContext

public final void createContext(ControllerContext context)
                         throws ControllerException

Contextualize the command.

Throws:

ControllerException

destroyContext

public final void destroyContext()

Destroy state after invocation.

create

protected void create()

destroy

protected void destroy()

execute

public abstract ControllerResponse execute()
                                    throws ControllerException

Execute the command.

Throws:

ControllerException

rethrow

public static void rethrow(java.lang.Exception e)
                    throws ControllerException,
                           org.jboss.portal.common.invocation.InvocationException,
                           java.lang.RuntimeException

Throws:

ControllerException

org.jboss.portal.common.invocation.InvocationException

java.lang.RuntimeException