io.micronaut.http.annotation

Annotation Type CustomHttpMethod

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @HttpMethodMapping
public @interface CustomHttpMethod

This annotation is designed for non-standard http methods, that you can provide by specifying the required method() property.

Since:

1.3.0

Author:

spirit-1984

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	method

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	consumes The default consumes.
java.lang.String[]	processes Shortcut that allows setting both the consumes() and produces() settings to the same media type.
java.lang.String[]	produces
boolean	single Shortcut that allows setting both the Consumes and Produces single settings.
java.lang.String	uri
java.lang.String[]	uris Only to be used in the context of a server.
java.lang.String	value

Element Detail

method

public abstract java.lang.String method

Returns:

The name of the non-standard http method.

value

@AliasFor(annotation=HttpMethodMapping.class,member="value") @AliasFor(annotation=UriMapping.class,member="value")
public abstract java.lang.String value

Returns:

The URI of the route

Default:

"/"

uri

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

Returns:

The URI of the route

Default:

"/"

uris

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

Only to be used in the context of a server.

Returns:

The URIs of the route

Default:

"/"

produces

@AliasFor(annotation=Produces.class,
          member="value")
public abstract java.lang.String[] produces

Returns:

The default produces, otherwise override from controller

Default:

{}

consumes

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

The default consumes. Ignored for server request which never a consume a value for a GET request.

Returns:

The default consumes, otherwise override from controller

Default:

{}

processes

@AliasFor(annotation=Produces.class,member="value") @AliasFor(annotation=Consumes.class,member="value")
public abstract java.lang.String[] processes

Shortcut that allows setting both the consumes() and produces() settings to the same media type.

Returns:

The media type this method processes

Default:

{}

single

@AliasFor(annotation=Produces.class,member="single") @AliasFor(annotation=Consumes.class,member="single") @AliasFor(annotation=SingleResult.class,member="value")
public abstract boolean single

Shortcut that allows setting both the Consumes and Produces single settings.

Returns:

Whether a single or multiple items are produced/consumed

Default:

false