org.broadleafcommerce.common.controller

Annotation Type FrameworkMapping

@Target(value={TYPE,METHOD})
@Retention(value=RUNTIME)
@Documented
public @interface FrameworkMapping

This annotation behaves exactly like RequestMapping except it is used inside FrameworkController and FrameworkRestController controllers.

This reasoning for this annotation instead of just using RequestMapping is that when framework controllers haven't been enabled and a framework controller is extended by a class annotated with Controller or RestController then the undesired RequestMappings will get picked up once again due to Spring's annotation inheritance mechanics.

Since:

5.2

See Also:

RequestMapping, FrameworkController, FrameworkRestController

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	consumes
String[]	headers
org.springframework.web.bind.annotation.RequestMethod[]	method
String	name
String[]	params
String[]	path
String[]	produces
String[]	value

Element Detail

name

public abstract String name

See Also:

RequestMapping.name()

Default:

""

value

@AliasFor(value="path")
public abstract String[] value

See Also:

RequestMapping.value()

Default:

{}

path

@AliasFor(value="value")
public abstract String[] path

See Also:

RequestMapping.path()

Default:

{}

method

public abstract org.springframework.web.bind.annotation.RequestMethod[] method

See Also:

RequestMapping.method()

Default:

{}

params

public abstract String[] params

See Also:

RequestMapping.params()

Default:

{}

headers

public abstract String[] headers

See Also:

RequestMapping.headers()

Default:

{}

consumes

public abstract String[] consumes

See Also:

RequestMapping.consumes()

Default:

{}

produces

public abstract String[] produces

See Also:

RequestMapping.produces()

Default:

{}