org.dmfs.httpessentials.client.HttpResponseHandler Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 Marten Gajda 
 *
 *
 * 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.dmfs.httpessentials.client;

import org.dmfs.httpessentials.exceptions.ProtocolError;
import org.dmfs.httpessentials.exceptions.ProtocolException;

import java.io.IOException;


/**
 * An interface of a handler for responses.
 *
 * @param 
 *         The type of the response object returned.
 *
 * @author Marten Gajda 
 */
public interface HttpResponseHandler
{
    /**
     * Actually handles the {@link HttpResponse}. This method "converts" the response into an object of type T.
     *
     * @param response
     *         The response object.
     *
     * @return An object that represents the result, may be null if no result is expected.
     *
     * @throws IOException
     * @throws ProtocolError
     * @throws ProtocolException
     */
    public T handleResponse(HttpResponse response) throws IOException, ProtocolError, ProtocolException;
}