org.broadleafcommerce.frameworkmapping.annotation

Annotation Type FrameworkController

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface FrameworkController

Indicates that an annotated class is a "Framework Controller" (default MVC controller).

This means that if FrameworkControllerScan is included in the application configuration (and FrameworkController is in its FrameworkControllerScan.includeFilters()), then the classes annotated with this will be scanned and included in the application context. The FrameworkMappings in these classes will be added to handler mappings with a lower priority than RequestMappings found within a class annotated with Controller. This priority is achieved through FrameworkMappingHandlerMapping having a higher order value than RequestMappingHandlerMapping.

The intention is that you are able to specify MVC controllers and mappings within a framework module as the default MVC mappings and a client application can essentially override those mappings without causing an ambiguous mapping exception.

The site handler mappings in play in order of precedence from highest to lowest are:

1. RequestMappingHandlerMapping
2. FrameworkMappingHandlerMapping

This concept was adapted from @FrameworkEndpoint from Spring Security OAuth 2.

Author:

Philip Baggett (pbaggett)

See Also:

FrameworkMapping, FrameworkControllerScan

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value

Element Detail

value

public abstract String value

Default:

""