PluginExecutorService.java

/*
 * Copyright 2014 dc-square 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 com.hivemq.spi.services;

import com.google.common.util.concurrent.ListeningScheduledExecutorService;

import java.util.List;

/**
 * A shared thread pool executor which is a {@link ListeningScheduledExecutorService}.
 * It is recommended to use this instead of creating your own thread(-pool) in your plugin.
 * <p/>
 * Use this class for all concurrent code.
 *
 * @author Christoph Schäbel
 */
public interface PluginExecutorService extends ListeningScheduledExecutorService {

    /**
     * DO NOT CALL THIS METHOD!
     * <p/>
     * The Plugin Executor Service is automatically shut down when HiveMQ is shut down.
     * <p/>
     * Manual calls to this method from the plugin system are not supported.
     *
     * @throws {@link UnsupportedOperationException} always
     */
    @Override
    void shutdown();

    /**
     * DO NOT CALL THIS METHOD!
     * <p/>
     * The Plugin Executor Service is automatically shut down when HiveMQ shuts down.
     * <p/>
     * Manual calls to this method from the plugin system are not supported.
     *
     * @throws {@link UnsupportedOperationException} always
     */
    @Override
    List<Runnable> shutdownNow();

}