HttpConnectionResponseInterceptor.java

/*
 * Copyright (c) 2015 IBM Corp. All rights reserved.
 *
 * 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.cloudant.http;

/**
 * A Response Interceptor is run after the response is obtained from the
 * server but before the output stream is returned to the original client. The Response
 * Interceptor enables two main behaviours:
 * <ul>
 * <li>Modifying the response for every request</li>
 *
 * <li> Replaying a (potentially modified) request by reacting to the
 * response.</li>
 * </ul>
 *
 * Interceptors are executed in a pipeline and modify the context in a serial fashion.
 *
 * @since 2.0.0
 */
public interface HttpConnectionResponseInterceptor extends HttpConnectionInterceptor {

    /**
     * Intercept the response
     *
     * This method <strong>must not</strong> do any of the following
     * <ul>
     * <li>Return null</li>
     * <li>Read the response stream</li>
     * </ul>
     *
     * @param context Input context
     * @return Output context
     */
    HttpConnectionInterceptorContext interceptResponse(HttpConnectionInterceptorContext context);
}