Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom schedulers to execute @PreDestroy methods #4716

Merged
merged 1 commit into from
Feb 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
* 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 Public License v. 2.0, which is available at
Expand Down Expand Up @@ -65,7 +65,6 @@ class ClientExecutorProvidersConfigurator extends AbstractExecutorProvidersConfi
@Override
public void init(InjectionManager injectionManager, BootstrapBag bootstrapBag) {
Map<String, Object> runtimeProperties = bootstrapBag.getConfiguration().getProperties();
ManagedObjectsFinalizer finalizer = bootstrapBag.getManagedObjectsFinalizer();

ExecutorServiceProvider defaultAsyncExecutorProvider;
ScheduledExecutorServiceProvider defaultScheduledExecutorProvider;
Expand Down Expand Up @@ -110,7 +109,6 @@ public void init(InjectionManager injectionManager, BootstrapBag bootstrapBag) {
.to(ExecutorServiceProvider.class);

injectionManager.register(executorBinding);
finalizer.registerForPreDestroyCall(defaultAsyncExecutorProvider);

final ScheduledExecutorService clientScheduledExecutorService = client.getScheduledExecutorService() == null
// scheduled executor service set from {@link ClientConfig}.
Expand All @@ -134,9 +132,9 @@ public void init(InjectionManager injectionManager, BootstrapBag bootstrapBag) {
.service(defaultScheduledExecutorProvider)
.to(ScheduledExecutorServiceProvider.class);
injectionManager.register(schedulerBinding);
finalizer.registerForPreDestroyCall(defaultScheduledExecutorProvider);

registerExecutors(injectionManager, componentBag, defaultAsyncExecutorProvider, defaultScheduledExecutorProvider);
registerExecutors(injectionManager, componentBag, defaultAsyncExecutorProvider,
defaultScheduledExecutorProvider, bootstrapBag.getManagedObjectsFinalizer());
}

private static ExecutorService lookupManagedExecutorService() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
* 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 Public License v. 2.0, which is available at
Expand All @@ -24,6 +24,7 @@
import org.glassfish.jersey.internal.BootstrapConfigurator;
import org.glassfish.jersey.internal.inject.InjectionManager;
import org.glassfish.jersey.model.internal.ComponentBag;
import org.glassfish.jersey.model.internal.ManagedObjectsFinalizer;
import org.glassfish.jersey.spi.ExecutorServiceProvider;
import org.glassfish.jersey.spi.ScheduledExecutorServiceProvider;

Expand All @@ -49,12 +50,14 @@ public abstract class AbstractExecutorProvidersConfigurator implements Bootstrap
* @param componentBag provides executor service providers registered by an application.
* @param defaultAsyncExecutorProvider default implementation of {@link ExecutorServiceProvider}.
* @param defaultScheduledExecutorProvider default implementation of {@link ScheduledExecutorServiceProvider}.
* @param finalizer register finalizers.
*/
protected void registerExecutors(
InjectionManager injectionManager,
ComponentBag componentBag,
ExecutorServiceProvider defaultAsyncExecutorProvider,
ScheduledExecutorServiceProvider defaultScheduledExecutorProvider) {
ScheduledExecutorServiceProvider defaultScheduledExecutorProvider,
ManagedObjectsFinalizer finalizer) {

List<ExecutorServiceProvider> customExecutors =
Stream.concat(
Expand All @@ -64,6 +67,7 @@ protected void registerExecutors(
.map(CAST_TO_EXECUTOR_PROVIDER)
.collect(Collectors.toList());
customExecutors.add(defaultAsyncExecutorProvider);
customExecutors.stream().forEach(e -> finalizer.registerForPreDestroyCall(e));

List<ScheduledExecutorServiceProvider> customScheduledExecutors =
Stream.concat(
Expand All @@ -73,6 +77,7 @@ protected void registerExecutors(
.map(CAST_TO_SCHEDULED_EXECUTOR_PROVIDER)
.collect(Collectors.toList());
customScheduledExecutors.add(defaultScheduledExecutorProvider);
customScheduledExecutors.stream().forEach(e -> finalizer.registerForPreDestroyCall(e));

ExecutorProviders.registerExecutorBindings(injectionManager, customExecutors, customScheduledExecutors);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
* 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 Public License v. 2.0, which is available at
Expand Down Expand Up @@ -41,7 +41,6 @@ public void init(InjectionManager injectionManager, BootstrapBag bootstrapBag) {
ServerBootstrapBag serverBag = (ServerBootstrapBag) bootstrapBag;
ResourceConfig runtimeConfig = serverBag.getRuntimeConfig();
ComponentBag componentBag = runtimeConfig.getComponentBag();
ManagedObjectsFinalizer finalizer = serverBag.getManagedObjectsFinalizer();

// TODO: Do we need to register DEFAULT Executor and ScheduledExecutor to InjectionManager?
ScheduledExecutorServiceProvider defaultScheduledExecutorProvider = new DefaultBackgroundSchedulerProvider();
Expand All @@ -50,16 +49,15 @@ public void init(InjectionManager injectionManager, BootstrapBag bootstrapBag) {
.to(ScheduledExecutorServiceProvider.class)
.qualifiedBy(BackgroundSchedulerLiteral.INSTANCE);
injectionManager.register(schedulerBinding);
finalizer.registerForPreDestroyCall(defaultScheduledExecutorProvider);

ExecutorServiceProvider defaultAsyncExecutorProvider = new DefaultManagedAsyncExecutorProvider();
InstanceBinding<ExecutorServiceProvider> executorBinding = Bindings
.service(defaultAsyncExecutorProvider)
.to(ExecutorServiceProvider.class);
injectionManager.register(executorBinding);
finalizer.registerForPreDestroyCall(defaultAsyncExecutorProvider);

registerExecutors(injectionManager, componentBag, defaultAsyncExecutorProvider, defaultScheduledExecutorProvider);
registerExecutors(injectionManager, componentBag, defaultAsyncExecutorProvider,
defaultScheduledExecutorProvider, serverBag.getManagedObjectsFinalizer());
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/

package org.glassfish.jersey.tests.e2e.server;

import java.util.concurrent.RejectedExecutionHandler;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.ThreadFactory;

import javax.inject.Singleton;
import javax.ws.rs.core.Application;

import org.glassfish.jersey.server.BackgroundScheduler;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.spi.ScheduledThreadPoolExecutorProvider;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

public class ScheduledThreadPoolExecutorProviderTest {

@Test
public void restartShutsdownScheduler() throws Exception {
WebContainer container = new WebContainer();
container.setUp();
container.tearDown();
assertNotNull(CustomScheduledThreadPoolExecutorProvider.executor);
assertTrue(CustomScheduledThreadPoolExecutorProvider.selfRef.isClosed());
assertTrue(CustomScheduledThreadPoolExecutorProvider.executor.isShutdown());
}

private static class WebContainer extends JerseyTest {
@Override
protected Application configure() {
return new ResourceConfig(CustomScheduledThreadPoolExecutorProvider.class);
}
}

@BackgroundScheduler
@Singleton
public static class CustomScheduledThreadPoolExecutorProvider extends ScheduledThreadPoolExecutorProvider {

private static CustomScheduledThreadPoolExecutorProvider selfRef;
private static ScheduledThreadPoolExecutor executor;

public CustomScheduledThreadPoolExecutorProvider() {
this("CustomScheduledThreadPoolExecutorProvider");
}

public CustomScheduledThreadPoolExecutorProvider(String name) {
super(name);
CustomScheduledThreadPoolExecutorProvider.selfRef = this;
}

@Override
protected ScheduledThreadPoolExecutor createExecutor(int corePoolSize, ThreadFactory threadFactory,
RejectedExecutionHandler handler) {
executor = new ScheduledThreadPoolExecutor(5, threadFactory, handler);
return executor;
}
}
}