1 /*
2 * Copyright (c) 2002-2025 Gargoyle Software Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * https://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15 package org.htmlunit;
16
17 import java.io.Serializable;
18
19 import org.htmlunit.html.HtmlPage;
20
21 /**
22 * This class is notified when AJAX calls are made, and has the ability to influence these calls.
23 * For instance, it can turn asynchronous AJAX calls into synchronous AJAX calls, making test code
24 * deterministic and avoiding calls to <code>Thread.sleep()</code>.
25 *
26 * @author Marc Guillemot
27 */
28 public class AjaxController implements Serializable {
29
30 /**
31 * Gets notified of an AJAX call to determine how it should be processed.
32 * @param page the page the request comes from
33 * @param request the request that should be performed
34 * @param async indicates if the request should originally be asynchronous
35 * @return if the call should be synchronous or not; here just like the original call
36 */
37 public boolean processSynchron(final HtmlPage page, final WebRequest request, final boolean async) {
38 return !async;
39 }
40
41 }