001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.client;
028
029import java.io.IOException;
030
031import org.apache.http.HttpResponse;
032
033/**
034 * Handler that encapsulates the process of generating a response object
035 * from a {@link HttpResponse}.
036 *
037 *
038 * @since 4.0
039 */
040public interface ResponseHandler<T> {
041
042    /**
043     * Processes an {@link HttpResponse} and returns some value
044     * corresponding to that response.
045     *
046     * @param response The response to process
047     * @return A value determined by the response
048     *
049     * @throws ClientProtocolException in case of an http protocol error
050     * @throws IOException in case of a problem or the connection was aborted
051     */
052    T handleResponse(HttpResponse response) throws ClientProtocolException, IOException;
053
054}