站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

ControllerCommand - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.core.controller
Class ControllerCommand

java.lang.Object
  extended byorg.jboss.portal.common.invocation.Invocation
      extended byorg.jboss.portal.core.controller.ControllerCommand
Direct Known Subclasses:
PortalObjectCommand, SignOutCommand, StreamContentCommand

public abstract class ControllerCommand
extends Invocation

A controller command.

Version:
$Revision: 5448 $
Author:
Julien Viet

Field Summary
protected  ControllerContext context
          The context of the command.
private static InvocationHandler handler
          Execute command when the end of the stack is reached.
protected static org.jboss.logging.Logger log
          .
static Scope NAVIGATIONAL_STATE_SCOPE
          .
static Scope PRINCIPAL_SCOPE
          .
static Scope REQUEST_SCOPE
          .
static Scope SESSION_SCOPE
          .
 
Fields inherited from class org.jboss.portal.common.invocation.Invocation
EMPTY_STACK
 
Constructor Summary
protected ControllerCommand()
           
 
Method Summary
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  java.lang.Object execute()
          Execute the command.
 InvocationContext getContext()
          Return the invocation context or throw IllegalStateException.
 ControllerContext getControllerContext()
           
abstract  CommandInfo getInfo()
          Return the meta data of this command.
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 Scope PRINCIPAL_SCOPE
.


SESSION_SCOPE

public static final Scope SESSION_SCOPE
.


REQUEST_SCOPE

public static final Scope REQUEST_SCOPE
.


NAVIGATIONAL_STATE_SCOPE

public static final Scope NAVIGATIONAL_STATE_SCOPE
.


log

protected static org.jboss.logging.Logger log
.


context

protected ControllerContext context
The context of the command.


handler

private static final InvocationHandler handler
Execute command when the end of the stack is reached.

Constructor Detail

ControllerCommand

protected ControllerCommand()
Method Detail

getInfo

public abstract CommandInfo getInfo()
Return the meta data of this command.


getContext

public final InvocationContext getContext()
Description copied from class: Invocation
Return the invocation context or throw IllegalStateException.

Specified by:
getContext in class Invocation
Returns:
the invocation context

getControllerContext

public final ControllerContext getControllerContext()

enforceSecurity

public void enforceSecurity(PortalAuthorizationManager pam)
                     throws ControllerSecurityException,
                            PortalSecurityException
Enforce the security on this command.

Throws:
PortalSecurityException
ControllerSecurityException

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()
               throws ControllerException
Throws:
ControllerException

destroy

protected void destroy()

execute

public abstract java.lang.Object execute()
                                  throws ControllerException
Execute the command.

Throws:
ControllerException

rethrow

public static void rethrow(java.lang.Exception e)
                    throws ControllerException,
                           InvocationException,
                           java.lang.RuntimeException
Throws:
ControllerException
InvocationException
java.lang.RuntimeException