001/*
002 * Copyright 2002-2009 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.client;
018
019import java.io.IOException;
020
021import org.springframework.http.client.ClientHttpResponse;
022
023/**
024 * Generic callback interface used by {@link RestTemplate}'s retrieval methods
025 * Implementations of this interface perform the actual work of extracting data
026 * from a {@link ClientHttpResponse}, but don't need to worry about exception
027 * handling or closing resources.
028 *
029 * <p>Used internally by the {@link RestTemplate}, but also useful for application code.
030 *
031 * @author Arjen Poutsma
032 * @since 3.0
033 * @see RestTemplate#execute
034 */
035public interface ResponseExtractor<T> {
036
037        /**
038         * Extract data from the given {@code ClientHttpResponse} and return it.
039         * @param response the HTTP response
040         * @return the extracted data
041         * @throws IOException in case of I/O errors
042         */
043        T extractData(ClientHttpResponse response) throws IOException;
044
045}