Package javax.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
    See Also:
    GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS
    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String DELETE
      HTTP DELETE method.
      static java.lang.String GET
      HTTP GET method.
      static java.lang.String HEAD
      HTTP HEAD method.
      static java.lang.String OPTIONS
      HTTP OPTIONS method.
      static java.lang.String PATCH
      HTTP PATCH method.
      static java.lang.String POST
      HTTP POST method.
      static java.lang.String PUT
      HTTP PUT method.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      Specifies the name of a HTTP method.
    • Field Detail

      • GET

        static final java.lang.String GET
        HTTP GET method.
      • POST

        static final java.lang.String POST
        HTTP POST method.
      • PUT

        static final java.lang.String PUT
        HTTP PUT method.
      • DELETE

        static final java.lang.String DELETE
        HTTP DELETE method.
      • PATCH

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

        static final java.lang.String HEAD
        HTTP HEAD method.
      • OPTIONS

        static final java.lang.String OPTIONS
        HTTP OPTIONS method.
    • Element Detail

      • value

        java.lang.String value
        Specifies the name of a HTTP method. E.g. "GET".