com.sun.xml.ws.commons.AbstractTaskManager Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.commons;

import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicBoolean;
import com.sun.istack.logging.Logger;

import com.sun.xml.ws.api.Component;

/**
 * Abstract parent of *TaskManager classes com.sun.xml.ws.commons created to
 * avoid duplication of code in the individual implementations
 *
 */
public abstract class AbstractTaskManager {
    private final AtomicBoolean isClosed;
    private volatile ScheduledExecutorService executorService;
    private boolean useContainerSpi = true;

    protected abstract Component getComponent();
    protected abstract String getThreadPoolName();
    protected abstract ThreadFactory createThreadFactory();
    protected abstract int getThreadPoolSize();
    protected abstract Logger getLogger();

    protected AbstractTaskManager() {
        this.isClosed = new AtomicBoolean(false);
    }

    /**
     * shutdown the ScheduledExecutorService if we created it.
     * @param force - if true, wait for time given by delayMillis, then force shutdown if needed
     * @param delayMillis
     */
    protected void close(boolean force, long delayMillis) {
        if (useContainerSpi) return;
        if (executorService == null) return;
        if (isClosed.compareAndSet(false, true)) {
            executorService.shutdown();
        }
        if (!force) return;

        if (!executorService.isTerminated()) {
            try {
                Thread.sleep(delayMillis);
            } catch (InterruptedException ex) {
                getLogger().fine("Interrupted while waiting for a scheduler to shut down.", ex);
            }
            if (!executorService.isTerminated()) {
                executorService.shutdownNow();
            }
        }
    }

    /**
     * shutdown the ScheduledExecutorService if we created it.
     */
    public void close() {
        close(false, 0);
    }

    public boolean isClosed() {
        if (useContainerSpi) return false;
        return isClosed.get();
    }

    /**
     * Return the appropriate ScheduledExecutorService - on initial access, check for container.getSPI
     * NOTE - A COPY OF THIS METHOD CAN BE FOUND AT {@code com.sun.xml.ws.metro.api.config.management.ManagedEndpoint#getExecutorService() ManagedEndpoint.getExecutorService() } IN metro-cm-api
     * IF A SUITABLE COMMON LOCATION CAN BE FOUND BOTH COPIES MUST BE MOVED
     * @return
     */
    protected ScheduledExecutorService getExecutorService() {
        if (executorService == null) {
            synchronized (this) {
                if (executorService == null) {
                    if (getComponent() != null) {
                        executorService = getComponent().getSPI(ScheduledExecutorService.class);
                    }
                    if (executorService == null) {
                        //container did not return an SPI - create our own thread pool
                        getLogger().finer("Container did not return SPI for ScheduledExecutorService - creating thread pool for " + getThreadPoolName());
                        ThreadFactory threadFactory = createThreadFactory();
                        if (threadFactory == null) {
                            executorService = Executors.newScheduledThreadPool(getThreadPoolSize());
                        } else {
                            executorService = Executors.newScheduledThreadPool(getThreadPoolSize(), threadFactory);
                        }
                        useContainerSpi = false;
                    } else {
                        getLogger().finer("Using Container SPI for ScheduledExecutorService for " + getThreadPoolName());
                        useContainerSpi = true;
                    }
                    this.isClosed.set(false);
                }
            }
        }
        return executorService;
    }
}