org.htmlunit.AjaxController Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of htmlunit Show documentation

A headless browser intended for use in testing web-based applications.

The newest version!

/*
 * Copyright (c) 2002-2024 Gargoyle Software Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.htmlunit;

import java.io.Serializable;

import org.htmlunit.html.HtmlPage;

/**
 * This class is notified when AJAX calls are made, and has the ability to influence these calls.
 * For instance, it can turn asynchronous AJAX calls into synchronous AJAX calls, making test code
 * deterministic and avoiding calls to Thread.sleep().
 *
 * @author Marc Guillemot
 */
public class AjaxController implements Serializable {

    /**
     * Gets notified of an AJAX call to determine how it should be processed.
     * @param page the page the request comes from
     * @param request the request that should be performed
     * @param async indicates if the request should originally be asynchronous
     * @return if the call should be synchronous or not; here just like the original call
     */
    public boolean processSynchron(final HtmlPage page, final WebRequest request, final boolean async) {
        return !async;
    }

}