com.gwtplatform.dispatch.rpc.server.guice

Class HandlerModule

java.lang.Object

com.google.inject.AbstractModule

com.gwtplatform.dispatch.rpc.server.guice.HandlerModule

All Implemented Interfaces:

Module

public abstract class HandlerModule
extends AbstractModule

Base module that will bind Actions to ActionHandlers and ActionValidators. Your own Guice modules should extend this class.

Constructor Summary

Constructors

Constructor and Description
HandlerModule() Constructs a HandlerModule that uses the DispatchModule with default configuration.
HandlerModule(DispatchModule dispatchModule) Constructs a HandlerModule that uses the DispatchModule with a custom configuration.

Method Summary

Methods

Modifier and Type	Method and Description
protected <A extends Action<R>,R extends Result> void	bindHandler(Class<A> actionClass, Class<? extends ActionHandler<A,R>> handlerClass)
protected <A extends Action<R>,R extends Result> void	bindHandler(Class<A> actionClass, Class<? extends ActionHandler<A,R>> handlerClass, Class<? extends ActionValidator> actionValidator)
protected void	configure()
protected abstract void	configureHandlers() Override this method to configure your handlers.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, 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

Constructor Detail

HandlerModule

public HandlerModule()

Constructs a HandlerModule that uses the DispatchModule with default configuration.

HandlerModule

public HandlerModule(DispatchModule dispatchModule)

Constructs a HandlerModule that uses the DispatchModule with a custom configuration.

Parameters:

dispatchModule - The custom configured DispatchModule

Method Detail

bindHandler

protected <A extends Action<R>,R extends Result> void bindHandler(Class<A> actionClass,
                                                      Class<? extends ActionHandler<A,R>> handlerClass)

Type Parameters:

A - Type of Action

R - Type of Result

Parameters:

actionClass - Implementation of Action to link and bind

handlerClass - Implementation of ActionHandler to link and bind

bindHandler

protected <A extends Action<R>,R extends Result> void bindHandler(Class<A> actionClass,
                                                      Class<? extends ActionHandler<A,R>> handlerClass,
                                                      Class<? extends ActionValidator> actionValidator)

Type Parameters:

A - Type of Action

R - Type of Result

Parameters:

actionClass - Implementation of Action to link and bind

handlerClass - Implementation of ActionHandler to link and bind

actionValidator - Implementation of ActionValidator to link and bind

configure

protected final void configure()

Specified by:

configure in class AbstractModule

configureHandlers

protected abstract void configureHandlers()

Override this method to configure your handlers. Use calls to bindHandler(java.lang.Class<A>, java.lang.Class<? extends com.gwtplatform.dispatch.rpc.server.actionhandler.ActionHandler<A, R>>) to register actions that do not need any specific security validation.