Servlet3Adapter.java

/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2012-2015 ForgeRock AS.
 */

package org.forgerock.http.servlet;

import java.io.IOException;

import jakarta.servlet.AsyncContext;
import jakarta.servlet.AsyncEvent;
import jakarta.servlet.AsyncListener;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import org.forgerock.http.servlet.Servlet2Adapter.Servlet2Synchronizer;

/**
 * An adapter for use in Servlet 3.x containers.
 */
final class Servlet3Adapter implements ServletVersionAdapter {

    /**
     * Synchronization implementation - only used when the container supports
     * asynchronous processing.
     */
    private final static class Servlet3Synchronizer implements ServletSynchronizer {
        private final AsyncContext asyncContext;

        private Servlet3Synchronizer(HttpServletRequest httpRequest) {
            if (httpRequest.isAsyncStarted()) {
                this.asyncContext = httpRequest.getAsyncContext();
            } else {
                this.asyncContext = httpRequest.startAsync();
                // Disable timeouts for certain containers - see http://java.net/jira/browse/GRIZZLY-1325
                asyncContext.setTimeout(0);
            }
        }

        @Override
        public void setAsyncListener(final Runnable runnable) {
            asyncContext.addListener(new AsyncListener() {

                @Override
                public void onComplete(AsyncEvent event) throws IOException {
                    runnable.run();
                }

                @Override
                public void onError(AsyncEvent event) throws IOException {
                    runnable.run();
                }

                @Override
                public void onStartAsync(AsyncEvent event) throws IOException {
                    // Reregister.
                    event.getAsyncContext().addListener(this);
                }

                @Override
                public void onTimeout(AsyncEvent event) throws IOException {
                    runnable.run();
                }
            });
        }

        @Override
        public void awaitIfNeeded() throws InterruptedException {
            // Nothing to signal: this dispatcher is non-blocking.
        }

        @Override
        public void signalAndComplete() {
            asyncContext.complete();
        }
    }

    Servlet3Adapter() {
        // Nothing to do.
    }

    @Override
    public ServletSynchronizer createServletSynchronizer(HttpServletRequest httpRequest,
            HttpServletResponse httpResponse) {
        if (httpRequest.isAsyncSupported()) {
            return new Servlet3Synchronizer(httpRequest);
        } else {
            // Fall-back to Servlet 2 blocking implementation.
            return new Servlet2Synchronizer();
        }
    }
}