ratpack.session.store

Class CookieBasedSessionsModule

java.lang.Object

com.google.inject.AbstractModule

ratpack.guice.ConfigurableModule<CookieBasedSessionsModule.Config>

ratpack.session.store.CookieBasedSessionsModule

All Implemented Interfaces:

Module, HandlerDecoratingModule

public class CookieBasedSessionsModule
extends ConfigurableModule<CookieBasedSessionsModule.Config>
implements HandlerDecoratingModule

An extension module that provides a cookie based store for sessions.

Provides

• SessionStorage - deserialized from the client's cookie

Getting the session storage

This module decorates the handler to make the SessionStorage available during request processing.

 import ratpack.handling.*;
 import ratpack.session.store.SessionStorage;

 class MyHandler implements Handler {
   void handle(Context ctx) {
     SessionStorage session = ctx.get(SessionStorage.class);
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CookieBasedSessionsModule.Config

Constructor Summary

Constructors

Constructor and Description
CookieBasedSessionsModule()

Method Summary

Modifier and Type	Method and Description
protected void	configure()
Handler	decorate(Injector injector, Handler handler) Makes SessionStorage available in the context registry.

Methods inherited from class ratpack.guice.ConfigurableModule

configure, createConfig, defaultConfig

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.inject.Module

configure

Constructor Detail

CookieBasedSessionsModule

public CookieBasedSessionsModule()

Method Detail

configure

protected void configure()

Specified by:

configure in class AbstractModule

decorate

public Handler decorate(Injector injector,
                        Handler handler)

Makes SessionStorage available in the context registry.

Specified by:

decorate in interface HandlerDecoratingModule

Parameters:

injector - The injector created from all the application modules

handler - The application handler

Returns:

A handler that provides a SessionStorage impl in the context registry