org.jooby

Class FlashScope

java.lang.Object

org.jooby.FlashScope

All Implemented Interfaces:

Jooby.Module

public class FlashScope
extends Object
implements Jooby.Module

flash scope

The flash scope is designed to transport success and error messages, between requests. The flash scope is similar to Session but lifecycle is shorter: data are kept for only one request.

The flash scope is implemented as client side cookie, so it helps to keep application stateless.

usage

 {
   use(new FlashScope());

   get("/", req -> {
     return req.ifFlash("success").orElse("Welcome!");
   });

   post("/", req -> {
     req.flash("success", "The item has been created");
     return Results.redirect("/");
   });
 }
 

FlashScope is also available on mvc routes via Flash annotation:

 @Path("/")
 public class Controller {

   @GET
   public Object flashScope(@Flash Map<String, String> flash) {
     ...
   }

   @GET
   public Object flashAttr(@Flash String foo) {
     ...
   }

   @GET
   public Object optionlFlashAttr(@Flash Optional<String> foo) {
     ...
   }
 }
 

Worth to mention that flash attributes are accessible from template engine by prefixing attributes with flash.. Here is a handlebars.java example:

 {{#if flash.success}}
   {{flash.success}}
 {{else}}
   Welcome!
 {{/if}}
 

Since:

1.0.0.CR4

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
FlashScope() Creates a new FlashScope.
FlashScope(Cookie.Definition cookie) Creates a new FlashScope and customize the flash cookie.

Method Summary

Modifier and Type	Method and Description
void	configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder) Configure and produces bindings for the underlying application.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jooby.Jooby.Module

config

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

FlashScope

public FlashScope(Cookie.Definition cookie)

Creates a new FlashScope and customize the flash cookie.

Parameters:

cookie - Cookie template for flash scope.

FlashScope

public FlashScope()

Creates a new FlashScope.

Method Detail

configure

public void configure(Env env,
                      com.typesafe.config.Config conf,
                      com.google.inject.Binder binder)

Description copied from interface: Jooby.Module

Configure and produces bindings for the underlying application. A module can optimize or customize a service by checking current the application env and/or the current application properties available from Config.

Specified by:

configure in interface Jooby.Module

Parameters:

env - The current application's env. Not null.

conf - The current config object. Not null.

binder - A guice binder. Not null.