Chapter 6. @HeaderParam


The @HeaderParam annotation allows you to map a request HTTP header onto your method invocation.
  GET /books?num=5
Copy to Clipboard Toggle word wrap
   
   @GET
   public String getBooks(@HeaderParam("From") String from) {
   ...
   }
Copy to Clipboard Toggle word wrap
As with @PathParam, the type of parameter can be a primitive, a String, or a class with a String constructor or static valueOf() method. For example, MediaType has a valueOf() method, so you could do the following:
   @PUT
   public void put(@HeaderParam("Content-Type") MediaType contentType, ...)
Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat