org.codehaus.griffon.runtime.core.controller

Class AbstractActionInterceptor

java.lang.Object

org.codehaus.griffon.runtime.core.controller.AbstractActionInterceptor

All Implemented Interfaces:

ActionInterceptor

public class AbstractActionInterceptor
extends Object
implements ActionInterceptor

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields inherited from interface griffon.core.controller.ActionInterceptor

SUFFIX

Constructor Summary

Constructors

Constructor and Description
AbstractActionInterceptor()

Method Summary

Modifier and Type	Method and Description
protected AbortActionExecution	abortActionExecution()
void	after(ActionExecutionStatus status, GriffonController controller, String actionName, Object[] args) Called after the action has been aborted or executed, even if an exception occurred during execution.
Object[]	before(GriffonController controller, String actionName, Object[] args) Called before an action is executed.
void	configure(GriffonController controller, String actionName, Method method) Inspect the action during the configuration phase.
boolean	exception(Exception exception, GriffonController controller, String actionName, Object[] args) Called after the action has been executed when an exception occurred during execution.
protected String	qualifyActionName(GriffonController controller, String actionName)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractActionInterceptor

public AbstractActionInterceptor()

Method Detail

configure

public void configure(@Nonnull
                      GriffonController controller,
                      @Nonnull
                      String actionName,
                      @Nonnull
                      Method method)

Description copied from interface: ActionInterceptor

Inspect the action during the configuration phase.

This is the perfect time to search for annotations or any other information required by the action. Interceptors have the option to cache such inspections and recall them during before(), after() and exception().

Specified by:

configure in interface ActionInterceptor

Parameters:

controller - the controller that owns the action

actionName - the action's name

method - the method that represents the action itself

before

@Nonnull
public Object[] before(@Nonnull
                                GriffonController controller,
                                @Nonnull
                                String actionName,
                                @Nonnull
                                Object[] args)

Description copied from interface: ActionInterceptor

Called before an action is executed.

Implementors have the choice of throwing an AbortActionExecution in order to signal that the action should not be invoked. In any case this method returns the arguments to be sent to the action, thus allowing the interceptor to modify the arguments as it deem necessary. Failure to return an appropriate value will most likely cause an error during the action's execution.

Specified by:

before in interface ActionInterceptor

Parameters:

controller - the controller that owns the action

actionName - the action's name

args - the action's arguments

Returns:

arguments to be sent to the action

after

public void after(@Nonnull
                  ActionExecutionStatus status,
                  @Nonnull
                  GriffonController controller,
                  @Nonnull
                  String actionName,
                  @Nonnull
                  Object[] args)

Description copied from interface: ActionInterceptor

Called after the action has been aborted or executed, even if an exception occurred during execution.

Specified by:

after in interface ActionInterceptor

Parameters:

status - a flag that indicates the execution status of the action

controller - the controller that owns the action

actionName - the action's name

args - the arguments sent to the action

exception

public boolean exception(@Nonnull
                         Exception exception,
                         @Nonnull
                         GriffonController controller,
                         @Nonnull
                         String actionName,
                         @Nonnull
                         Object[] args)

Description copied from interface: ActionInterceptor

Called after the action has been executed when an exception occurred during execution.

The exception will be rethrown by the ActionManager if is not handled by any interceptor.

Specified by:

exception in interface ActionInterceptor

Parameters:

exception - the exception thrown during the action's execution

controller - the controller that owns the action

actionName - the action's name

args - the arguments sent to the action during execution

Returns:

true if the exception was handled successfully, false otherwise.

abortActionExecution

@Nonnull
protected AbortActionExecution abortActionExecution()
                                                      throws AbortActionExecution

Throws:

AbortActionExecution

qualifyActionName

@Nonnull
protected String qualifyActionName(@Nonnull
                                            GriffonController controller,
                                            @Nonnull
                                            String actionName)