RequestFilter.java

/*
 * Copyright 2014 Grow Bit
 *
 * 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
 *
 *     http://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.turbogwt.net.http.client;

/**
 * An extension interface implemented by request filters.
 * Request filters are intended to manipulate the request before it is sent to the server.
 *
 * @author Danilo Reinert
 */
public interface RequestFilter {

    /**
     * Filter method called before a request has been dispatched to a client transport layer.
     *
     * @param request   The request to be dispatched.
     */
    void filter(Request request);
}