1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2012-2015 ForgeRock AS.
15 */
16
17 package org.forgerock.http.servlet;
18
19 import jakarta.servlet.http.HttpServletRequest;
20 import jakarta.servlet.http.HttpServletResponse;
21
22 /**
23 * A Servlet API version adapter provides an abstraction which allows Servlet
24 * and Filter implementations to interact with the Servlet container
25 * independently of the Servlet API version. At the moment the adapter only
26 * provides an abstraction for performing asynchronous processing, but other API
27 * features could be added in future (such as async IO).
28 */
29 interface ServletVersionAdapter {
30
31 /**
32 * Creates a new synchronizer appropriate for the provided HTTP request.
33 *
34 * @param httpRequest
35 * The HTTP request.
36 * @param httpResponse
37 * The HTTP response.
38 * @return Returns a new synchronizer appropriate for the HTTP request.
39 */
40 ServletSynchronizer createServletSynchronizer(HttpServletRequest httpRequest, HttpServletResponse httpResponse);
41 }