Skip to main content

Working with request cookie in Jersey (JAX-RS) guide

Usually, RESTful web services will not use request cookies. There might be some cases where we need it.

We had tested or used the following tools and technologies in this project:

  1. Jersey (v 2.21)
  2. Gradle Build System (v 2.9)
  3. Spring Boot (v 1.3)
  4. Java (v 1.8)
  5. Eclipse IDE

@CookieParam annotation for getting individual Request Cookies

In the Jersey Resource RequestCookiesResource class, we can inject cookie values using @CookieParam at the instance variable and method parameter level. We use it similar to @HeaderParam, @QueryParam or other @*Param annotation.

getRequestCookie the method implements API URI /request-cookie. When API request pass cookies with name token and content-type, response gives back cookies and their values in JSON format.

File: RequestCookiesResource.java

package in.geekmj.resource;

import java.util.HashMap;
import java.util.Map;

import javax.ws.rs.CookieParam;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;

@Path("/request-cookie")
@Produces(MediaType.APPLICATION\_JSON)
public class RequestCookiesResource {

	/*
	 * We can inject request cookie as an instance variables using @CookieParam
	*/

	@CookieParam("token")
	private String token;

	/* We can inject request cookie values in method using @CookieParam */
	@GET
	public Map<string, string=""> getRequestCookie(@</string,>CookieParam("content-type") String contentType) {

		Map<string, string=""> requestCookies = new HashMap<string, string="">();
		requestCookies.put("token", token);
		requestCookies.put("contentType", contentType);
		return requestCookies;
	}
}

Testing https://localhost:8080/request-cookie API using Postman.

Note: To learn how to send cookies along with API requests using Postman, please read this useful article.

Jersey gets individual request cookies
 

Response:

{
  "contentType": "text/html",
  "token": "dummy-token-12345"
}

Getting all Request Cookies in a Map

we can use getCookies method on HttpHeaders to fetch all cookie information on a Map. Using @Context we can inject HttpHeaders at the instance variable or method parameter level.

In method getAllRequestCookiesUsingContext we defined URI /request-cookie/all. This API will return all request cookies in JSON format.

File: RequestCookiesResource.java

package in.geekmj.resource;

import java.util.HashMap;
import java.util.Map;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;

@Path("/request-cookie")
@Produces(MediaType.APPLICATION\_JSON)
public class RequestCookiesResource {
	/*
	 * We can get a map of all request headers name and value using HttpHeaders
	 * context injection
	 */

	@SuppressWarnings("rawtypes")
	@GET
	@Path("/all")
	public Map getAllRequestCookiesUsingContext(@Context HttpHeaders headers) {
		return headers.getCookies();
	}
}

Testing https://localhost:8080/request-cookie/all API using Postman.


 Get all cookies map Response:

{
    "name": {
        "name": "name",
        "value": "geekmj",
        "version": 0,
        "path": null,
        "domain": null
    },
    "content-type": {
        "name": "content-type",
        "value": "text/html",
        "version": 0,
        "path": null,
        "domain": null
    },
    "token": {
        "name": "token",
        "value": "dummy-token-12345",
        "version": 0,
        "path": null,
        "domain": null
    }
}

References

  1. What is HTTP Cookie?

  2. Official Jersey Documentation

  3. Download the Full Project

  4. Follow Project On Github

Comments

Popular posts from this blog

Working with request header in Jersey (JAX-RS) guide

In the  previous post , we talked about, how to get parameters and their values from the request query string. In this guide learn how to get request header values in Jersey (JAX-RS) based application. We had tested or used the following tools and technologies in this project: Jersey (v 2.21) Gradle Build System (v 2.9) Spring Boot (v 1.3) Java (v 1.8) Eclipse IDE This is a part of  Jersey (JAX-RS) Restful Web Services Development Guides series. Please read Jersey + Spring Boot getting started guide . Gradle Build File We are using Gradle for our build and dependency management (Using Maven rather than Gradle is a very trivial task). File: build.gradle buildscript { ext { springBootVersion = '1.3.0.RELEASE' } repositories { mavenCentral() } dependencies { classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") } } apply plugin: 'java' apply plugin: 'eclipse' a

Ajax Cross Domain Resource Access Using jQuery

Some time back in our project we faced a problem while making an Ajax call using jQuery. Chrome Browser console had given some weird error message like below when we try to access one of our web pages: When we try to access the same web page in the Firefox browser, it doesn't give any error in the console but some parsing error occurred. In our case, we were accessing XML as an Ajax request resource. I was curious to check if the non-XML cross-domain resource was successfully loading or not. But finally, I realized that it is not going through. jersey-spring-boot-quick-starter-guide In our Ajax call, requesting domain was not the same as the requested URL domain. $.ajax({ url: "https://10.11.2.171:81/xxxxxx/xxxxxxx.xml" , type : "get" , success: function (response) { alert( "Load was performed." ); }, error : function (xhr, status) {

FastAPI first shot

Setup on my Mac (Macbook Pro 15 inch Retina, Mid 2014) Prerequisite Python 3.6+ (I used 3.7.x. I recently reinstalled OS after cleaning up disk, where stock Python 2.7 was available. I installed Pyenv and then used it to install 3.7.x). I already had a git repo initialized at Github for this project. I checked that out. I use this approach to keep all the source code safe or at a specific place 😀. I set the Python version in .python-version file. I also initialize the virtual environment using pyenv in venv folder. I started the virtual environment. FastAPI specific dependencies setup Now I started with basic pip commands to install dependency for the project. I saved dependencies in requirements.txt  the file. Minimal viable code to spin an API Server FastAPI is as cool as NodeJS or Go Lang (?) to demonstrate the ability to spin an API endpoint up and running in no time. I had the same feeling for the Flask too, which was also super cool. app/main.py: from typing i