ClientRequestFilter.java

/**
 *    Copyright 2014 Opower, 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
 *
 *    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 com.opower.rest.client.generator.core;

/**
 * ClientRequestFilters allow manipulation of the http request before it is sent. This could mean
 * adding a special header or parameter etc. The filters are executed in order.
 * @author chris.phillips
 */
public interface ClientRequestFilter {

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