OWLS-20819: Servlet AsyncContext not reused.

- updated the Jersey Servlet 3 integration code to reuse an existing AsyncContext, if available.

Change-Id: I60d581dc24f0ab6786c65a0d194a1d01b0d8df4f
Signed-off-by: Marek Potociar <[email protected]>

Author: Marek Potociar

containers/jersey-servlet/src/main/java/org/glassfish/jersey/servlet/async/AsyncContextDelegateProviderImpl.java

@@ -41,15 +41,17 @@
 
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import javax.servlet.AsyncContext;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+import org.glassfish.jersey.servlet.init.internal.LocalizationMessages;
 import org.glassfish.jersey.servlet.spi.AsyncContextDelegate;
 import org.glassfish.jersey.servlet.spi.AsyncContextDelegateProvider;
 
-
 /**
  * Servlet 3.x container response writer async extension and related extension factory implementation.
  *
@@ -58,6 +60,8 @@
  */
 public class AsyncContextDelegateProviderImpl implements AsyncContextDelegateProvider {
 
+    private static final Logger LOGGER = Logger.getLogger(AsyncContextDelegateProviderImpl.class.getName());
+
     @Override
     public final AsyncContextDelegate createDelegate(final HttpServletRequest request, final HttpServletResponse response) {
         return new ExtensionImpl(request, response);
@@ -75,7 +79,7 @@ private static final class ExtensionImpl implements AsyncContextDelegate {
         /**
          * Create a Servlet 3.x {@link AsyncContextDelegate} with given {@code request} and {@code response}.
          *
-         * @param request request to create {@link AsyncContext} for.
+         * @param request  request to create {@link AsyncContext} for.
          * @param response response to create {@link AsyncContext} for.
          */
         private ExtensionImpl(final HttpServletRequest request, final HttpServletResponse response) {
@@ -89,13 +93,27 @@ private ExtensionImpl(final HttpServletRequest request, final HttpServletRespons
         public void suspend() throws IllegalStateException {
             // Suspend only if not completed and not suspended before.
             if (!completed.get() && asyncContextRef.get() == null) {
-                final AsyncContext asyncContext = request.startAsync(request, response);
+                asyncContextRef.set(getAsyncContext());
+            }
+        }
 
+        private AsyncContext getAsyncContext() {
+            final AsyncContext asyncContext;
+            if (request.isAsyncStarted()) {
+                asyncContext = request.getAsyncContext();
+                try {
+                    asyncContext.setTimeout(NEVER_TIMEOUT_VALUE);
+                } catch (IllegalStateException ex) {
+                    // Let's hope the time out is set properly, otherwise JAX-RS AsyncResponse time-out support
+                    // may not work as expected... At least we can log this at fine level...
+                    LOGGER.log(Level.FINE, LocalizationMessages.SERVLET_ASYNC_CONTEXT_ALREADY_STARTED(), ex);
+                }
+            } else {
+                asyncContext = request.startAsync(request, response);
                 // Tell underlying asyncContext to never time out.
                 asyncContext.setTimeout(NEVER_TIMEOUT_VALUE);
-
-                asyncContextRef.set(asyncContext);
             }
+            return asyncContext;
         }
 
         @Override

containers/jersey-servlet/src/main/resources/org/glassfish/jersey/servlet/init/internal/localization.properties

@@ -1,7 +1,7 @@
 #
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 #
-# Copyright (c) 2012-2014 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2012-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
@@ -44,3 +44,5 @@ jersey.app.no.mapping.or.annotation=The Jersey servlet application, named {0}, i
 jersey.app.registered.classes=Registering the Jersey servlet application, named {0}, with the following root resource and provider classes: {1}
 jersey.app.registered.mapping=Registering the Jersey servlet application, named {0}, at the servlet mapping {1}, with the Application class of the same name.
 jersey.app.registered.application=Registering the Jersey servlet application, named {0}, with the Application class of the same name.
+servlet.async.context.already.started=Servlet request has been put into asynchronous mode by an external force. \
+  Proceeding with the existing AsyncContext instance, but cannot guarantee the correct behavior of JAX-RS AsyncResponse time-out support.