Module jakarta.ws.rs

Package jakarta.ws.rs

Annotation Type HttpMethod

@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@Documented
public @interface HttpMethod

Associates the name of a HTTP method with an annotation. A Java method annotated with a runtime annotation that is itself annotated with this annotation will be used to handle HTTP requests of the indicated HTTP method. It is an error for a method to be annotated with more than one annotation that is annotated with HttpMethod.

Since:

1.0

Author:

Paul Sandoz, Marc Hadley

See Also:

• GET
• POST
• PUT
• DELETE
• PATCH
• HEAD
• OPTIONS

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	Specifies the name of a HTTP method.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELETE	HTTP DELETE method.
static final String	GET	HTTP GET method.
static final String	HEAD	HTTP HEAD method.
static final String	OPTIONS	HTTP OPTIONS method.
static final String	PATCH	HTTP PATCH method.
static final String	POST	HTTP POST method.
static final String	PUT	HTTP PUT method.

Field Details

GET

static final String GET

HTTP GET method.

See Also:

• Constant Field Values

POST

static final String POST

HTTP POST method.

See Also:

• Constant Field Values

PUT

static final String PUT

HTTP PUT method.

See Also:

• Constant Field Values

DELETE

static final String DELETE

HTTP DELETE method.

See Also:

• Constant Field Values

PATCH

static final String PATCH

HTTP PATCH method.

Since:

2.1

See Also:

• Constant Field Values

HEAD

static final String HEAD

HTTP HEAD method.

See Also:

• Constant Field Values

OPTIONS

static final String OPTIONS

HTTP OPTIONS method.

See Also:

• Constant Field Values

Element Details

value

String value

Specifies the name of a HTTP method. E.g. "GET".

Returns:

HTTP method name.