JERSEY-1982: @PreDestroy not invoked on Features

Change-Id: I45048131c989dc9adef7f855ec671345f3c40adf

Author: Petr Janouch

core-common/src/main/java/org/glassfish/jersey/model/internal/CommonConfig.java

@@ -62,6 +62,7 @@
 import javax.ws.rs.core.FeatureContext;
 
 import javax.annotation.Priority;
+import javax.inject.Singleton;
 
 import org.glassfish.jersey.ExtendedConfig;
 import org.glassfish.jersey.internal.LocalizationMessages;
@@ -77,6 +78,7 @@
 import org.glassfish.hk2.api.DynamicConfiguration;
 import org.glassfish.hk2.api.ServiceLocator;
 import org.glassfish.hk2.utilities.Binder;
+import org.glassfish.hk2.utilities.binding.ScopedBindingBuilder;
 
 import jersey.repackaged.com.google.common.base.Function;
 import jersey.repackaged.com.google.common.base.Predicate;
@@ -640,6 +642,8 @@ public void configureMetaProviders(final ServiceLocator locator) {
 
         // Check whether meta providers have been initialized for a config this config has been loaded from.
         if (!disableMetaProviderConfiguration) {
+
+            registerManagedObjectsFinalizer(locator);
             // Next, configure all features
             configureFeatures(
                     locator,
@@ -651,6 +655,15 @@ public void configureMetaProviders(final ServiceLocator locator) {
         }
     }
 
+    private void registerManagedObjectsFinalizer(ServiceLocator locator) {
+        DynamicConfiguration dc = Injections.getConfiguration(locator);
+        ScopedBindingBuilder<ManagedObjectsFinalizer> binder = Injections.newBinder(ManagedObjectsFinalizer.class)
+                .to(ManagedObjectsFinalizer.class)
+                .in(Singleton.class);
+        Injections.addBinding(binder, dc);
+        dc.commit();
+    }
+
     private Set<Binder> configureBinders(final ServiceLocator locator, final Set<Binder> configured) {
         final Set<Binder> allConfigured = Sets.newIdentityHashSet();
         allConfigured.addAll(configured);
@@ -684,6 +697,8 @@ private void configureFeatures(final ServiceLocator locator,
                                    final Set<FeatureRegistration> processed,
                                    final List<FeatureRegistration> unprocessed) {
 
+        ManagedObjectsFinalizer managedObjectsFinalizer = locator.getService(ManagedObjectsFinalizer.class);
+
         FeatureContextWrapper featureContextWrapper = null;
         for (final FeatureRegistration registration : unprocessed) {
             if (processed.contains(registration)) {
@@ -694,6 +709,7 @@ private void configureFeatures(final ServiceLocator locator,
             Feature feature = registration.getFeature();
             if (feature == null) {
                 feature = locator.createAndInitialize(registration.getFeatureClass());
+                managedObjectsFinalizer.registerForPreDestroyCall(feature);
             } else {
                 // Disable injection of Feature instances on the client-side. Instances may be registered into multiple
                 // web-targets which means that injecting anything into these instances is not safe.

core-common/src/main/java/org/glassfish/jersey/model/internal/ManagedObjectsFinalizer.java

@@ -0,0 +1,94 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+
+package org.glassfish.jersey.model.internal;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+import org.glassfish.hk2.api.ServiceLocator;
+
+/**
+ * Invokes {@link PreDestroy} methods on all registered objects, when the service locator is shut down.
+ * <p/>
+ * Some objects managed by Jersey are created using {@link ServiceLocator#createAndInitialize}. This means
+ * that such objects are created, dependencies injected and methods annotated with {@link javax.annotation.PostConstruct}
+ * invoked. Therefore methods annotated with {@link PreDestroy} should be invoked on such objects too, when they are destroyed.
+ * <p/>
+ * This service invokes {@link PreDestroy} on all registered objects when {@link ServiceLocator#shutdown()} is invoked
+ * on the service locator where this service is registered. Therefore only classes with their lifecycle linked
+ * to the service locator that created them should be registered here.
+ *
+ * @author Petr Janouch (petr.janouch at oracle.com)
+ */
+@Singleton
+public class ManagedObjectsFinalizer {
+
+    @Inject
+    private ServiceLocator serviceLocator;
+
+    private final Set<Object> managedObjects = new HashSet<Object>();
+
+    /**
+     * Register an object for invocation of its {@link PreDestroy} method.
+     * It will be invoked when the service locator is shut down.
+     *
+     * @param object an object to be registered.
+     */
+    public void registerForPreDestroyCall(Object object) {
+        managedObjects.add(object);
+    }
+
+    @PreDestroy
+    public void preDestroy() {
+        try {
+            for (Object o : managedObjects) {
+                serviceLocator.preDestroy(o);
+            }
+
+        } finally {
+            managedObjects.clear();
+        }
+    }
+}

tests/e2e/src/test/java/org/glassfish/jersey/tests/e2e/client/ClientDestroyTest.java

@@ -53,6 +53,8 @@
 import javax.ws.rs.client.ClientRequestContext;
 import javax.ws.rs.client.ClientRequestFilter;
 import javax.ws.rs.core.Application;
+import javax.ws.rs.core.Feature;
+import javax.ws.rs.core.FeatureContext;
 import javax.ws.rs.ext.ReaderInterceptor;
 import javax.ws.rs.ext.ReaderInterceptorContext;
 
@@ -86,6 +88,7 @@ public void setUp() throws Exception {
         destroyed.clear();
         destroyed.put("filter", false);
         destroyed.put("reader", false);
+        destroyed.put("feature", false);
 
         super.setUp();
     }
@@ -126,11 +129,25 @@ public void preDestroy() {
         }
     }
 
+    public static class MyFeature implements Feature {
+
+        @PreDestroy
+        public void preDestroy() {
+            destroyed.put("feature", true);
+        }
+
+        @Override
+        public boolean configure(final FeatureContext context) {
+            return true;
+        }
+    }
+
     @Test
     public void testClientInvokePreDestroyMethodOnProviderClass() throws Exception {
         final Client client = ClientBuilder.newClient()
                 .register(MyFilter.class)
-                .register(MyReader.class);
+                .register(MyReader.class)
+                .register(MyFeature.class);
 
         assertThat(client.target(getBaseUri()).request().get(String.class), is("reader-resource-bar"));
 

tests/e2e/src/test/java/org/glassfish/jersey/tests/e2e/server/ServerDestroyTest.java

@@ -51,6 +51,8 @@
 import javax.ws.rs.container.ContainerResponseContext;
 import javax.ws.rs.container.ContainerResponseFilter;
 import javax.ws.rs.core.Application;
+import javax.ws.rs.core.Feature;
+import javax.ws.rs.core.FeatureContext;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.WriterInterceptor;
 import javax.ws.rs.ext.WriterInterceptorContext;
@@ -97,6 +99,7 @@ public void setUp() throws Exception {
         destroyed.put("filter", false);
         destroyed.put("writer", false);
         destroyed.put("singleton-factory", false);
+        destroyed.put("feature", false);
 
         super.setUp();
     }
@@ -153,7 +156,12 @@ public void preDestroy() {
 
         @Override
         public Set<Class<?>> getClasses() {
-            return Sets.<Class<?>>newHashSet(Resource.class, MyFilter.class, MyWriter.class, MyContainerLifecycleListener.class);
+            return Sets.<Class<?>>newHashSet(
+                    Resource.class,
+                    MyFilter.class,
+                    MyWriter.class,
+                    MyContainerLifecycleListener.class,
+                    MyFeature.class);
         }
 
         @Override
@@ -214,6 +222,19 @@ public void onShutdown(final Container container) {
         }
     }
 
+    public static class MyFeature implements Feature {
+
+        @PreDestroy
+        public void preDestroy() {
+            destroyed.put("feature", true);
+        }
+
+        @Override
+        public boolean configure(final FeatureContext context) {
+            return true;
+        }
+    }
+
     @Override
     protected DeploymentContext configureDeployment() {
         reloader = new Reloader();