RpcDispatchAsyncModule.java

/*
 * Copyright 2011 ArcBees Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.gwtplatform.dispatch.rpc.client.gin;

import javax.inject.Singleton;

import com.google.gwt.core.client.GWT;
import com.google.inject.Provides;
import com.gwtplatform.dispatch.client.DefaultSecurityCookieAccessor;
import com.gwtplatform.dispatch.client.gin.AbstractDispatchAsyncModule;
import com.gwtplatform.dispatch.rpc.client.DefaultExceptionHandler;
import com.gwtplatform.dispatch.rpc.client.DefaultRpcDispatchCallFactory;
import com.gwtplatform.dispatch.rpc.client.DefaultRpcDispatchHooks;
import com.gwtplatform.dispatch.rpc.client.ExceptionHandler;
import com.gwtplatform.dispatch.rpc.client.RpcBinding;
import com.gwtplatform.dispatch.rpc.client.RpcDispatchAsync;
import com.gwtplatform.dispatch.rpc.client.RpcDispatchCallFactory;
import com.gwtplatform.dispatch.rpc.client.RpcDispatchHooks;
import com.gwtplatform.dispatch.rpc.client.interceptor.DefaultRpcInterceptorRegistry;
import com.gwtplatform.dispatch.rpc.client.interceptor.RpcInterceptorRegistry;
import com.gwtplatform.dispatch.rpc.shared.DispatchAsync;
import com.gwtplatform.dispatch.rpc.shared.DispatchService;
import com.gwtplatform.dispatch.rpc.shared.DispatchServiceAsync;

/**
 * An implementation of {@link AbstractDispatchAsyncModule} that uses Remote Procedure Calls (RPC).
 * <p/>
 * This gin module provides provides access to the {@link DispatchAsync} singleton, which is used to make calls to the
 * server over RPC.
 * <p/>
 * If you want to prevent XSRF attack (you use secured {@link com.gwtplatform.dispatch.rpc.shared.Action}s) the empty
 * {@link DefaultSecurityCookieAccessor} could leave your application vulnerable to XSRF attacks.
 *
 * @see <a href="http://www.gwtproject.org/articles/security_for_gwt_applications.html#xsrf">This document</a>.
 */
public class RpcDispatchAsyncModule extends AbstractDispatchAsyncModule {
    /**
     * A {@link RpcDispatchAsyncModule} builder.
     */
    public static class Builder extends AbstractDispatchAsyncModule.Builder<Builder> {
        protected Class<? extends DispatchAsync> dispatchAsync = RpcDispatchAsync.class;

        private Class<? extends ExceptionHandler> exceptionHandler = DefaultExceptionHandler.class;
        private Class<? extends RpcDispatchCallFactory> dispatchCallFactory = DefaultRpcDispatchCallFactory.class;
        private Class<? extends RpcDispatchHooks> dispatchHooks = DefaultRpcDispatchHooks.class;
        private Class<? extends RpcInterceptorRegistry> interceptorRegistry = DefaultRpcInterceptorRegistry.class;

        @Override
        public RpcDispatchAsyncModule build() {
            return new RpcDispatchAsyncModule(this);
        }

        public Class<? extends ExceptionHandler> getExceptionHandler() {
            return exceptionHandler;
        }

        public Class<? extends RpcDispatchHooks> getDispatchHooks() {
            return dispatchHooks;
        }

        public Class<? extends RpcInterceptorRegistry> getInterceptorRegistry() {
            return interceptorRegistry;
        }

        public Class<? extends DispatchAsync> getDispatchAsync() {
            return dispatchAsync;
        }

        public Class<? extends RpcDispatchCallFactory> getDispatchCallFactory() {
            return dispatchCallFactory;
        }

        /**
         * Specify an alternative exception handler.
         *
         * @param exceptionHandler The {@link ExceptionHandler} class.
         *
         * @return a {@link Builder} object.
         */
        public Builder exceptionHandler(Class<? extends ExceptionHandler> exceptionHandler) {
            this.exceptionHandler = exceptionHandler;
            return this;
        }

        /**
         * Supply your own implementation of {@link com.gwtplatform.dispatch.rpc.client.RpcDispatchHooks}.
         * Default is {@link com.gwtplatform.dispatch.rpc.client.DefaultRpcDispatchHooks}
         *
         * @param dispatchHooks The {@link com.gwtplatform.dispatch.rpc.client.RpcDispatchHooks} implementation.
         * @return this {@link RpcDispatchAsyncModule.Builder} object.
         */
        public Builder dispatchHooks(Class<? extends RpcDispatchHooks> dispatchHooks) {
            this.dispatchHooks = dispatchHooks;
            return this;
        }

        /**
         * Supply your own implementation of {@link com.gwtplatform.dispatch.rpc.shared.DispatchAsync}.
         * Default is {@link com.gwtplatform.dispatch.rpc.client.RpcDispatchAsync}
         *
         * @param dispatchAsync The {@link com.gwtplatform.dispatch.rpc.shared.DispatchAsync} implementation.
         * @return this {@link RpcDispatchAsyncModule.Builder} object.
         */
        public Builder dispatchAsync(Class<? extends DispatchAsync> dispatchAsync) {
            this.dispatchAsync = dispatchAsync;
            return this;
        }

        /**
         * Supply your own implementation of {@link com.gwtplatform.dispatch.rpc.client.RpcDispatchCallFactory}.
         * Default is {@link com.gwtplatform.dispatch.rpc.client.DefaultRpcDispatchCallFactory}
         *
         * @param dispatchCallFactory The {@link com.gwtplatform.dispatch.rpc.client.RpcDispatchCallFactory}
         *                            implementation.
         * @return this {@link RpcDispatchAsyncModule.Builder} object.
         */
        public Builder dispatchCallFactory(Class<? extends RpcDispatchCallFactory> dispatchCallFactory) {
            this.dispatchCallFactory = dispatchCallFactory;
            return this;
        }

        /**
         * Specify an alternate RPC interceptor registry.
         *
         * @param interceptorRegistry A {@link RpcInterceptorRegistry} class.
         *
         * @return this {@link RpcDispatchAsyncModule.Builder builder} object.
         */
        public Builder interceptorRegistry(Class<? extends RpcInterceptorRegistry> interceptorRegistry) {
            this.interceptorRegistry = interceptorRegistry;
            return this;
        }

        @Override
        protected Builder self() {
            return this;
        }
    }

    private final Builder builder;

    public RpcDispatchAsyncModule() {
        this(new Builder());
    }

    protected RpcDispatchAsyncModule(Builder builder) {
        super(builder, RpcBinding.class);

        this.builder = builder;
    }

    @Override
    protected void configureDispatch() {
        bind(RpcDispatchCallFactory.class).to(builder.getDispatchCallFactory()).in(Singleton.class);
        bind(DispatchAsync.class).to(builder.getDispatchAsync()).in(Singleton.class);
        bind(RpcInterceptorRegistry.class).to(builder.getInterceptorRegistry()).in(Singleton.class);
        bind(RpcDispatchHooks.class).to(builder.getDispatchHooks()).in(Singleton.class);
        bindAnnotated(ExceptionHandler.class).to(builder.getExceptionHandler());
    }

    @Provides
    @Singleton
    DispatchServiceAsync provideDispatchServiceAsync() {
        return GWT.create(DispatchService.class);
    }
}