griffon.core.controller

Interface ActionInterceptor

All Known Implementing Classes:

AbstractActionInterceptor

public interface ActionInterceptor

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUFFIX

Method Summary

Methods

Modifier and Type	Method and Description
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.

Field Detail

SUFFIX

static final String SUFFIX

See Also:

Constant Field Values

Method Detail

configure

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

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().

Parameters:

controller - the controller that owns the action

actionName - the action's name

method - the method that represents the action itself

before

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

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.

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

Throws:

AbortActionExecution - if action execution should be aborted.

after

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

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

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

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

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.

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.