Package io.micronaut.http.annotation

Annotation Interface Options

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@HttpMethodMapping
@Inherited
public @interface Options

Annotation that can be applied to method to signify the method receives a HttpMethod.OPTIONS.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	consumes
String	uri
String[]	uris	Only to be used in the context of a server.
String	value

Element Details

value

@AliasFor(annotation=HttpMethodMapping.class,member="value") @AliasFor(annotation=UriMapping.class,member="value")
String value

Returns:

The URI of the OPTIONS route

Default:

"/"

uri

@AliasFor(annotation=HttpMethodMapping.class,member="value") @AliasFor(annotation=UriMapping.class,member="value")
String uri

Returns:

The URI of the OPTIONS route

Default:

"/"

uris

@AliasFor(annotation=HttpMethodMapping.class,member="uris") @AliasFor(annotation=UriMapping.class,member="uris")
String[] uris

Only to be used in the context of a server.

Returns:

The URIs of the OPTIONS route

Default:

{"/"}

consumes

@AliasFor(annotation=Consumes.class,
          member="value")
String[] consumes

Returns:

The default consumes, otherwise override from controller

Default:

{}