ExecutorModule.java

/**
 * Copyright 2010 CosmoCode GmbH
 *
 * 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 de.cosmocode.palava.concurrent;

import java.lang.annotation.Annotation;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.RejectedExecutionHandler;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.base.Preconditions;
import com.google.inject.Key;
import com.google.inject.Singleton;
import com.google.inject.name.Names;

import de.cosmocode.palava.core.inject.AbstractRebindModule;

/**
 * This module can be used to rebind general executor service
 * configuration keys to specific ones.
 *
 * @author Willi Schoenborn
 */
public class ExecutorModule extends AbstractRebindModule {

    private static final Logger LOG = LoggerFactory.getLogger(ExecutorModule.class);

    private final Key<ExecutorService> key;
    
    private final String name;

    private final ExecutorConfig config;
    
    /**
     * Creates a new {@link ExecutorModule} which uses the given name to rebind configuration
     * entries and binds the configured {@link ExecutorService} using {@link Names#named(String)}.
     * 
     * @since 2.2
     * @param name the desired name
     */
    public ExecutorModule(String name) {
        this(Names.named(name), name);
    }
    
    public ExecutorModule(Class<? extends Annotation> annotation, String name) {
        this.key = Key.get(ExecutorService.class, Preconditions.checkNotNull(annotation, "Annotation"));
        this.name = Preconditions.checkNotNull(name, "Name");
        this.config = ExecutorConfig.named(name);
    }
    
    public ExecutorModule(Annotation annotation, String name) {
        this.key = Key.get(ExecutorService.class, Preconditions.checkNotNull(annotation, "Annotation"));
        this.name = Preconditions.checkNotNull(name, "Name");
        this.config = ExecutorConfig.named(name);
    }
    
    @Override
    protected void configuration() {
        LOG.trace("Binding executor configuration for {} using name {}", key, name);

        bind(String.class).annotatedWith(Names.named(ExecutorConfig.NAME)).toInstance(name);

        bind(int.class).annotatedWith(Names.named(ExecutorConfig.MIN_POOL_SIZE)).to(
            Key.get(int.class, Names.named(config.minPoolSize())));
        
        bind(int.class).annotatedWith(Names.named(ExecutorConfig.MAX_POOL_SIZE)).to(
            Key.get(int.class, Names.named(config.maxPoolSize())));
        
        bind(long.class).annotatedWith(Names.named(ExecutorConfig.KEEP_ALIVE_TIME)).to(
            Key.get(long.class, Names.named(config.keepAliveTime())));
        
        bind(TimeUnit.class).annotatedWith(Names.named(ExecutorConfig.KEEP_ALIVE_TIME_UNIT)).to(
            Key.get(TimeUnit.class, Names.named(config.keepAliveTimeUnit())));
        
        bind(QueueMode.class).annotatedWith(Names.named(ExecutorConfig.QUEUE_MODE)).to(
            Key.get(QueueMode.class, Names.named(config.queueMode())));
        
        bind(int.class).annotatedWith(Names.named(ExecutorConfig.QUEUE_CAPACITY)).to(
            Key.get(int.class, Names.named(config.queueCapacity())));
        
        bind(long.class).annotatedWith(Names.named(ExecutorConfig.SHUTDOWN_TIMEOUT)).to(
            Key.get(long.class, Names.named(config.shutdownTimeout())));
        
        bind(TimeUnit.class).annotatedWith(Names.named(ExecutorConfig.SHUTDOWN_TIMEOUT_UNIT)).to(
            Key.get(TimeUnit.class, Names.named(config.shutdownTimeoutUnit())));
    }
    
    @Override
    protected void optionals() {
        bind(ThreadFactory.class).annotatedWith(Names.named(ExecutorConfig.THREAD_FACTORY)).to(
            Key.get(ThreadFactory.class, Names.named(config.threadFactory())));
        
        bind(RejectedExecutionHandler.class).annotatedWith(Names.named(ExecutorConfig.REJECTION_HANDLER)).to(
            Key.get(RejectedExecutionHandler.class, Names.named(config.threadFactory())));
    }
    
    @Override
    protected void bindings() {
        bind(key).to(ConfigurableExecutorService.class).in(Singleton.class);
    }
    
    @Override
    protected void expose() {
        expose(key);
    }
    
}