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 Detail

      • GET

        static final String GET
        HTTP GET method.
      • POST

        static final String POST
        HTTP POST method.
      • PUT

        static final String PUT
        HTTP PUT method.
      • DELETE

        static final String DELETE
        HTTP DELETE method.
      • PATCH

        static final String PATCH
        HTTP PATCH method.
        Since:
        2.1
      • HEAD

        static final String HEAD
        HTTP HEAD method.
      • OPTIONS

        static final String OPTIONS
        HTTP OPTIONS method.
    • Element Detail

      • value

        String value
        Specifies the name of a HTTP method. E.g. "GET".
        Returns:
        HTTP method name.