Documentation

You are viewing the documentation for the 2.7.x release series. The latest stable release series is 3.0.x.

§Session and Flash scopes

§How it is different in Play

If you have to keep data across multiple HTTP requests, you can save them in the Session or the Flash scope. Data stored in the Session are available during the whole user session, and data stored in the flash scope are only available to the next request.

It’s important to understand that Session and Flash data are not stored in the server but are added to each subsequent HTTP Request, using Cookies. This means that the data size is very limited (up to 4 KB) and that you can only store string values.

Cookies are signed with a secret key so the client can’t modify the cookie data (or it will be invalidated). The Play session is not intended to be used as a cache. If you need to cache some data related to a specific session, you can use the Play built-in cache mechanism and use the session to store a unique ID to associate the cached data with a specific user.

§Session Configuration

Please see Configuring Session Cookies for more information for how to configure the session cookie parameters in application.conf.

§Session Timeout / Expiration

By default, there is no technical timeout for the Session. It expires when the user closes the web browser. If you need a functional timeout for a specific application, you set the maximum age of the session cookie by configuring the key play.http.session.maxAge in application.conf, and this will also set play.http.session.jwt.expiresAfter to the same value. The maxAge property will remove the cookie from the browser, and the JWT exp claim will be set in the cookie, and will make it invalid after the given duration. Please see Configuring Session Cookies for more information.

§Storing data into the Session

As the Session is just a Cookie, it is also just an HTTP header, but Play provides a helper method to store a session value:

public Result login(Http.Request request) {
  return ok("Welcome!").addingToSession(request, "connected", "[email protected]");
}

The same way, you can remove any value from the incoming session:

public Result logout(Http.Request request) {
  return ok("Bye").removingFromSession(request, "connected");
}

§Reading a Session value

You can retrieve the incoming Session from the HTTP request:

public Result index(Http.Request request) {
  return request
      .session()
      .getOptional("connected")
      .map(user -> ok("Hello " + user))
      .orElseGet(() -> unauthorized("Oops, you are not connected"));
}

§Discarding the whole session

If you want to discard the whole session, there is special operation:

public Result logout() {
  return ok("Bye").withNewSession();
}

§Flash scope

The Flash scope works exactly like the Session, but with two differences:

Important: The flash scope should only be used to transport success/error messages on simple non-Ajax applications. As the data are just kept for the next request and because there are no guarantees to ensure the request order in a complex Web application, the Flash scope is subject to race conditions.

So for example, after saving an item, you might want to redirect the user back to the index page, and you might want to display a message on the index page saying that the save was successful. In the save action, you would add the success message to the flash scope:

public Result save() {
  return redirect("/home").flashing("success", "The item has been created");
}

Then in the index action, you could check if the success message exists in the flash scope, and if so, render it:

public Result index(Http.Request request) {
  return ok(request.flash().getOptional("success").orElse("Welcome!"));
}

A flash value is also automatically available in Twirl templates. For example:

@flash("success").orElse("Welcome!")

Next: Body parsers

Found an error in this documentation? The source code for this page can be found here. After reading the documentation guidelines, please feel free to contribute a pull request. Have questions or advice to share? Go to our community forums to start a conversation with the community.