Important JAX-RS Annotations

Below JAX-RS annotations aid in mapping a resource class (a POJO) as a web resource:

  • @Path

    • specifies the relative path for a resource class or method.

  • @GET, @PUT, @POST, @DELETE and @HEAD

    • specify the HTTP request type of a resource.

  • @Produces

    • specifies the response Internet media types (used for content negotiation).

  • @Consumes

    • specifies the accepted request Internet media types.

 

JAX-RS provides further annotations to method parameters to pull information out of the request.

  • @PathParam

    • binds the method parameter to a path segment.

  • @QueryParam

    • binds the method parameter to the value of an HTTP query parameter.

  • @MatrixParam

    • binds the method parameter to the value of an HTTP matrix parameter.

  • @HeaderParam

    • binds the method parameter to an HTTP header value.

  • @CookieParam

    • binds the method parameter to a cookie value.

  • @FormParam

    • binds the method parameter to a form value.

  • @DefaultValue

    • specifies a default value for the above bindings when the key is not found.

  • @Context

    • returns the entire context of the object (for example @Context HttpServletRequest request).

Note: All the @*Param annotations take a key of some form which is used to look up the value required.

Search the Web

Custom Search

Searches whole web. Use the search in the right sidebar to search only within javajee.com!!!

Quick Notes Finder Tags

Activities (1) advanced java (1) agile (3) App Servers (6) archived notes (2) ArrayLists (1) Arrays (2) Best Practices (12) Best Practices (Design) (3) Best Practices (Java) (7) Best Practices (Java EE) (1) BigData (3) Chars & Encodings (6) coding problems (2) Collections (15) contests (3) Core Java (All) (52) course plan (2) Database (12) Design patterns (8) dev tools (3) downloads (2) eclipse (9) Essentials (1) examples (14) Exception (1) Exceptions (4) Exercise (1) exercises (6) Getting Started (18) Groovy (2) hadoop (4) hibernate (77) hibernate interview questions (6) History (1) Hot book (4) http monitoring (2) Inheritance (4) intellij (1) java 8 notes (4) Java 9 (1) Java Concepts (7) Java Core (7) java ee exercises (1) java ee interview questions (2) Java Elements (16) Java Environment (1) Java Features (4) java interview points (4) java interview questions (4) javajee initiatives (1) javajee thoughts (3) Java Performance (6) Java Programmer 1 (11) Java Programmer 2 (8) Javascript Frameworks (1) Java SE Professional (1) JSP (1) Legacy Java (1) linked list (3) maven (1) Multithreading (16) NFR (1) No SQL (1) Object Oriented (9) OCPJP (4) OCPWCD (1) OOAD (3) Operators (4) Overloading (2) Overriding (2) Overviews (1) policies (1) programming (1) Quartz Scheduler (1) Quizzes (17) RabbitMQ (1) references (2) resources (1) restful web service (3) Searching (1) security (10) Servlets (8) Servlets and JSP (31) Site Usage Guidelines (1) Sorting (1) source code management (1) spring (4) spring boot (3) Spring Examples (1) Spring Features (1) spring jpa (1) Stack (1) Streams & IO (3) Strings (11) SW Developer Tools (2) testing (1) troubleshooting (1) user interface (1) vxml (8) web services (1) Web Technologies (1) Web Technology Books (1) youtube (1)