src/main/java/org/apache/servicemix/executors/ExecutorFactory.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.servicemix.executors;

import org.apache.servicemix.executors.impl.ExecutorConfig;

import java.util.Map;

/**
 * Factory to create <code>Executor</code>s.
 * 
 * @author <a href="mailto:gnodet [at] gmail.com">Guillaume Nodet</a>
 */
public interface ExecutorFactory {

    /*
     * Configuration properties than can be passed along when creating an executor.
     * Every ExecutorFactory implementation can support one or more of these options, ignoring the unsupported ones.
     */
    String ALLOW_CORE_THREADS_TIMEOUT = ExecutorFactory.class.getName() + ".AllowCoreThreadTimeOut";
    String BYPASS_IF_SYNCHRONOUS = ExecutorFactory.class.getName() + ".BypassIfSynchronous";
    String CORE_POOL_SIZE = ExecutorFactory.class.getName() + ".CorePoolSize";
    String KEEP_ALIVE_TIME = ExecutorFactory.class.getName() + ".KeepAliveTime";
    String MAXIMUM_POOL_SIZE = ExecutorFactory.class.getName() + ".MaximumPoolSize";
    String QUEUE_SIZE = ExecutorFactory.class.getName() + ".QueueSize";
    String SHUTDOWN_DELAY = ExecutorFactory.class.getName() + ".ShutdownDelay";
    String THREAD_DAEMON = ExecutorFactory.class.getName() + ".ThreadDaemon";
    String THREAD_PRIORITY = ExecutorFactory.class.getName() + ".ThreadPriority";

    /**
     * Create a new executor for the given Id.
     * The id may be used to provide per executor
     * configuration.
     * 
     * @param id the id of the executor to create
     * @return a configured Executor
     */
    Executor createExecutor(String id);

    /**
     * Create a new executor for the given id
     * using the additional configuration options provided.
     *
     * Note that not every ExecutorFactory implementation will support all available options.  If the factory does
     * not support the option, it will get ignored.
     *
     * @param id the id of the executor to create
     * @param config the additional executor configuration options
     * @return a configured Executor
     */
    Executor createExecutor(String id, Map<String, Object> config);

    /**
     * Create a new daemon executor for the given Id.
     * The excutor should use daemon thread underlying
     * The id may be used to provide per executor
     * configuration.
     *
     * @param id the id of the executor to create
     * @return a configured Executor
     */
    Executor createDaemonExecutor(String id);
    
}