OF-885: Do not use async writing in error handling.

When the invocation of the #onTimeout method of a AsyncListener does
not result in a 'complete()', then the servlet container falls back to
default processing. This causes an async response that was started in
that method to fail.

src/java/org/jivesoftware/openfire/http/HttpBindServlet.java

@@ -272,7 +272,7 @@ public class HttpBindServlet extends HttpServlet {
         return reader;
     }
 
-    public static void respond(HttpSession session, AsyncContext context, String content) throws IOException
+    public static void respond(HttpSession session, AsyncContext context, String content, boolean async) throws IOException
     {
         final HttpServletResponse response = ((HttpServletResponse) context.getResponse());
         final HttpServletRequest request = ((HttpServletRequest) context.getRequest());
@@ -292,11 +292,17 @@ public class HttpBindServlet extends HttpServlet {
         }
         
         if (JiveGlobals.getBooleanProperty("log.httpbind.enabled", false)) {
-            System.out.println(new Date()+": HTTP SENT(" + session.getStreamID().getID() + "): " + content);
+            System.out.println(new Date() + ": HTTP SENT(" + session.getStreamID().getID() + "): " + content);
         }
 
         final byte[] byteContent = content.getBytes("UTF-8");
-        response.getOutputStream().setWriteListener( new WriteListenerImpl(context, byteContent) );
+        if (async) {
+            response.getOutputStream().setWriteListener(new WriteListenerImpl(context, byteContent));
+        } else {
+            context.getResponse().getOutputStream().write(byteContent);
+            context.getResponse().getOutputStream().flush();
+            context.complete();
+        }
     }
 
     private void sendError(HttpSession session, AsyncContext context, BoshBindingError bindingError)
@@ -309,7 +315,7 @@ public class HttpBindServlet extends HttpServlet {
             if ((session.getMajorVersion() == 1 && session.getMinorVersion() >= 6) || session.getMajorVersion() > 1)
             {
                 final String errorBody = createErrorBody(bindingError.getErrorType().getType(), bindingError.getCondition());
-                respond(session, context, errorBody);
+                respond(session, context, errorBody, true);
             } else {
                 sendLegacyError(context, bindingError);
             }

src/java/org/jivesoftware/openfire/http/HttpConnection.java

@@ -72,7 +72,7 @@ public class HttpConnection {
         }
 
         try {
-            deliverBody(null);
+            deliverBody(null, true);
         }
         catch (HttpConnectionClosedException e) {
             Log.warn("Unexpected exception occurred while trying to close an HttpException.", e);
@@ -106,11 +106,12 @@ public class HttpConnection {
      * sent an empty body.
      *
      * @param body the XMPP content to be forwarded to the client inside of a body tag.
+     * @param async when false, this method blocks until the data has been delivered to the client.
      *
      * @throws HttpConnectionClosedException when this connection to the client has already received
      * a deliverable to forward to the client
      */
-    public void deliverBody(String body) throws HttpConnectionClosedException, IOException {
+    public void deliverBody(String body, boolean async) throws HttpConnectionClosedException, IOException {
         // We only want to use this function once so we will close it when the body is delivered.
     	synchronized (this) {
 	        if (isClosed) {
@@ -123,7 +124,7 @@ public class HttpConnection {
         if (body == null) {
             body = HttpBindServlet.createEmptyBody(false);
         }
-        HttpBindServlet.respond(this.getSession(), this.context, body);
+        HttpBindServlet.respond(this.getSession(), this.context, body, async);
     }
 
     /**

src/java/org/jivesoftware/openfire/http/HttpSession.java

@@ -611,17 +611,17 @@ public class HttpSession extends LocalClientSession {
         int pauseDuration = HttpBindServlet.getIntAttribute(rootNode.attributeValue("pause"), -1);
 
         if ("terminate".equals(type)) {
-            connection.deliverBody(createEmptyBody(true));
+            connection.deliverBody(createEmptyBody(true), true);
             close();
             lastRequestID = connection.getRequestId();
         }
         else if ("true".equals(restartStream) && rootNode.elements().size() == 0) {
-            connection.deliverBody(createSessionRestartResponse());
+            connection.deliverBody(createSessionRestartResponse(), true);
             lastRequestID = connection.getRequestId();
         }
         else if (pauseDuration > 0 && pauseDuration <= getMaxPause()) {
             pause(pauseDuration);
-            connection.deliverBody(createEmptyBody(false));
+            connection.deliverBody(createEmptyBody(false), true);
             lastRequestID = connection.getRequestId();
             setLastResponseEmpty(true);
         }
@@ -700,14 +700,18 @@ public class HttpSession extends LocalClientSession {
         context.addListener(new AsyncListener() {
             @Override
             public void onComplete(AsyncEvent asyncEvent) throws IOException {
+                Log.debug("complete event " + asyncEvent);
                 connectionQueue.remove(connection);
                 fireConnectionClosed(connection);
             }
 
             @Override
             public void onTimeout(AsyncEvent asyncEvent) throws IOException {
+                Log.debug("timeout event " + asyncEvent);
                 try {
-                    connection.deliverBody(createEmptyBody());
+                    // If onTimeout does not result in a complete(), the container falls back to default behavior.
+                    // This is why this body is to be delivered in a non-async fashion.
+                    connection.deliverBody(createEmptyBody(), false);
                     setLastResponseEmpty(true);
 
                     // This connection timed out we need to increment the request count
@@ -725,6 +729,7 @@ public class HttpSession extends LocalClientSession {
 
             @Override
             public void onError(AsyncEvent asyncEvent) throws IOException {
+                Log.debug("error event " + asyncEvent);
                 Log.warn("Unhandled AsyncListener error: " + asyncEvent.getThrowable());
             }
 
@@ -739,7 +744,7 @@ public class HttpSession extends LocalClientSession {
                 throw new HttpBindException("Unexpected RID error.",
                         BoshBindingError.itemNotFound);
             }
-            connection.deliverBody(createDeliverable(deliverable.deliverables));
+            connection.deliverBody(createDeliverable(deliverable.deliverables), true);
             addConnection(connection, isPoll);
             return connection;
         }
@@ -805,7 +810,7 @@ public class HttpSession extends LocalClientSession {
 			                throw new HttpBindException("Unexpected RID error.",
 			                        BoshBindingError.itemNotFound);
 			            }
-			            connection.deliverBody(createDeliverable(deliverable.deliverables));
+			            connection.deliverBody(createDeliverable(deliverable.deliverables), true);
 					} else {
 						if(Log.isDebugEnabled()) {
 							Log.debug("It's still open - calling close()");
@@ -889,7 +894,7 @@ public class HttpSession extends LocalClientSession {
 
     private void deliver(HttpConnection connection, Collection<Deliverable> deliverable)
             throws HttpConnectionClosedException, IOException {
-        connection.deliverBody(createDeliverable(deliverable));
+        connection.deliverBody(createDeliverable(deliverable), true);
 
         Delivered delivered = new Delivered(deliverable);
         delivered.setRequestID(connection.getRequestId());
@@ -1041,7 +1046,7 @@ public class HttpSession extends LocalClientSession {
 					                pendingElements.clear();
 		            			}
 	            			} else {
-	            				toClose.deliverBody(null);
+	            				toClose.deliverBody(null, true);
 	            			}
 		            	}
 		            } catch (HttpConnectionClosedException e) {

src/java/org/jivesoftware/openfire/http/HttpSessionManager.java

@@ -202,7 +202,7 @@ public class HttpSessionManager {
 
         connection.setSession(session);
         try {
-            connection.deliverBody(createSessionCreationResponse(session));
+            connection.deliverBody(createSessionCreationResponse(session), true);
         }
         catch (HttpConnectionClosedException e) {
             Log.error("Error creating session.", e);