org.mojavemvc.core

Interface ControllerDatabase

All Known Implementing Classes:

MappedControllerDatabase

public interface ControllerDatabase

Author:

Luis Antunes

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Method Summary

Methods

Modifier and Type	Method and Description
ActionSignature	getActionMethodSignature(Class<?> controllerClass, String action) Get the ActionSignature associated with the given controller class.
ActionSignature	getAfterActionMethodFor(Class<?> controllerClass) Get the ActionSignature annotated with @AfterAction for the given controller class.
ActionSignature	getAfterActionMethodForInterceptor(Class<?> interceptorClass) Get the ActionSignature annotated with @AfterAction for the given interceptor class.
ActionSignature	getAfterConstructMethodFor(Class<?> controllerClass) Get the ActionSignature annotated with @AfterConstruct for the given controller class.
ActionSignature	getBeforeActionMethodFor(Class<?> controllerClass) Get the ActionSignature annotated with @BeforeAction for the given controller class.
ActionSignature	getBeforeActionMethodForInterceptor(Class<?> interceptorClass) Get the ActionSignature annotated with @BeforeAction for the given interceptor class.
Class<?>	getControllerClass(String controllerVariable) Get the controller Class associated with the given controller variable name.
ActionSignature	getDefaultActionMethodFor(Class<?> controllerClass) Get the ActionSignature annotated with @DefaultAction for the given controller class.
Class<?>	getDefaultControllerClass() Get the default controller for the application, if specified.
net.sf.cglib.reflect.FastClass	getFastClass(Class<?> clazz) Get the cached FastClass version of the given controller or interceptor class.
ActionSignature	getHttpMethodActionSignature(Class<?> controllerClass, HttpMethod httpMethod) Get the HTTP method ActionSignature associated with the given controller class.
Set<Class<?>>	getInitControllers() Get an unmodifiable set of singleton controller classes that are marked for creation during the FrontController init().
List<Class<?>>	getInterceptorsFor(Class<?> controllerClass) Get an unmodifiable list of Classes that represent interceptors for the given class, in the order in which they are declared in the @InterceptedBy annotation.
List<Class<?>>	getInterceptorsForAction(Class<?> controllerClass, String action) Get an unmodifiable list of Classes that represent interceptors for the given action method in the given class, in the order in which they are declared in the @InterceptedBy annotation.
List<Class<?>>	getInterceptorsForDefaultAction(Class<?> controllerClass) Get an unmodifiable list of Classes that represent interceptors for the default action method in the given class, in the order in which they are declared in the @InterceptedBy annotation.
List<Class<?>>	getInterceptorsForHttpMethodAction(Class<?> controllerClass, HttpMethod httpMethod) Get an unmodifiable list of Classes that represent interceptors for the given HTTP method action in the given class, in the order in which they are declared in the @InterceptedBy annotation.
RouteMap	getRouteMap() Get the RouteMap for the application.

Field Detail

KEY

static final String KEY

Method Detail

getControllerClass

Class<?> getControllerClass(String controllerVariable)

Get the controller Class associated with the given controller variable name.

Parameters:

controllerVariable -

Returns:

the controller class associated with the variable name

getActionMethodSignature

ActionSignature getActionMethodSignature(Class<?> controllerClass,
                                       String action)

Get the ActionSignature associated with the given controller class. ActionSignature is a thread-safe class.

Parameters:

controllerClass - the controller class

action - the request action

Returns:

the ActionSignature associated with the controller class

getBeforeActionMethodFor

ActionSignature getBeforeActionMethodFor(Class<?> controllerClass)

Get the ActionSignature annotated with @BeforeAction for the given controller class. ActionSignature is thread-safe.

Parameters:

controllerClass - the controller class

Returns:

the ActionSignature, or null if there is no ActionSignature annotated with @BeforeAction

getAfterActionMethodFor

ActionSignature getAfterActionMethodFor(Class<?> controllerClass)

Get the ActionSignature annotated with @AfterAction for the given controller class. ActionSignature is thread-safe.

Parameters:

controllerClass - the controller class

Returns:

the ActionSignature, or null if there is no ActionSignature annotated with @AfterAction

getDefaultActionMethodFor

ActionSignature getDefaultActionMethodFor(Class<?> controllerClass)

Get the ActionSignature annotated with @DefaultAction for the given controller class. ActionSignature is thread-safe.

Parameters:

controllerClass - the controller class

Returns:

the ActionSignature, or null if there is no method annotated with @DefaultAction

getAfterConstructMethodFor

ActionSignature getAfterConstructMethodFor(Class<?> controllerClass)

Get the ActionSignature annotated with @AfterConstruct for the given controller class. ActionSignature is thread-safe.

Parameters:

controllerClass - the controller class

Returns:

the ActionSignature, or null if there is no ActionSignature annotated with @AfterConstruct

getInitControllers

Set<Class<?>> getInitControllers()

Get an unmodifiable set of singleton controller classes that are marked for creation during the FrontController init().

Returns:

the singleton controller class

getInterceptorsFor

List<Class<?>> getInterceptorsFor(Class<?> controllerClass)

Get an unmodifiable list of Classes that represent interceptors for the given class, in the order in which they are declared in the @InterceptedBy annotation.

Parameters:

controllerClass - the controller class

Returns:

the classes of interceptors associated with the given class

getAfterActionMethodForInterceptor

ActionSignature getAfterActionMethodForInterceptor(Class<?> interceptorClass)

Get the ActionSignature annotated with @AfterAction for the given interceptor class. ActionSignature is thread-safe.

Parameters:

interceptorClass - the interceptor class

Returns:

the ActionSignature, or null if there is no ActionSignature annotated with @AfterAction

getBeforeActionMethodForInterceptor

ActionSignature getBeforeActionMethodForInterceptor(Class<?> interceptorClass)

Get the ActionSignature annotated with @BeforeAction for the given interceptor class. Method is thread-safe.

Parameters:

interceptorClass - the interceptor class

Returns:

the ActionSignature, or null if there is no ActionSignature annotated with @BeforeAction

getDefaultControllerClass

Class<?> getDefaultControllerClass()

Get the default controller for the application, if specified.

Returns:

the default controller class, or null if no @DefaultController is specified

getInterceptorsForAction

List<Class<?>> getInterceptorsForAction(Class<?> controllerClass,
                                      String action)

Get an unmodifiable list of Classes that represent interceptors for the given action method in the given class, in the order in which they are declared in the @InterceptedBy annotation.

Parameters:

controllerClass - the controller class

action - the action being invoked in the request

Returns:

an unmodifiable List of interceptor classes in the order in which they are declared, or null if there are no interceptors

getInterceptorsForDefaultAction

List<Class<?>> getInterceptorsForDefaultAction(Class<?> controllerClass)

Get an unmodifiable list of Classes that represent interceptors for the default action method in the given class, in the order in which they are declared in the @InterceptedBy annotation.

Parameters:

controllerClass - the controller class

Returns:

an unmodifiable List of interceptor classes in the order in which they are declared

getInterceptorsForHttpMethodAction

List<Class<?>> getInterceptorsForHttpMethodAction(Class<?> controllerClass,
                                                HttpMethod httpMethod)

Get an unmodifiable list of Classes that represent interceptors for the given HTTP method action in the given class, in the order in which they are declared in the @InterceptedBy annotation.

Parameters:

controllerClass - the controller class

httpMethod - the HTTP method being invoked in the request

Returns:

an unmodifiable List of interceptor classes in the order in which they are declared, or null if there are no interceptors

getFastClass

net.sf.cglib.reflect.FastClass getFastClass(Class<?> clazz)

Get the cached FastClass version of the given controller or interceptor class. FastClass is thread-safe.

Parameters:

clazz - the controller or interceptor class

Returns:

the FastClass version of the class

getHttpMethodActionSignature

ActionSignature getHttpMethodActionSignature(Class<?> controllerClass,
                                           HttpMethod httpMethod)

Get the HTTP method ActionSignature associated with the given controller class. ActionSignature is a thread-safe class.

Parameters:

controllerClass - the controller class

httpMethod - the HTTP method

Returns:

the ActionSignature associated with the controller class, or null if there is no Action for the given HttpMethod

getRouteMap

RouteMap getRouteMap()

Get the RouteMap for the application.

Returns:

the route map for the application