mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-07-30 14:29:19 +00:00
259 lines
11 KiB
Java
259 lines
11 KiB
Java
/*
|
|
* ====================================================================
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you 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.
|
|
* ====================================================================
|
|
*
|
|
* This software consists of voluntary contributions made by many
|
|
* individuals on behalf of the Apache Software Foundation. For more
|
|
* information on the Apache Software Foundation, please see
|
|
* <http://www.apache.org/>.
|
|
*
|
|
*/
|
|
|
|
package ch.boye.httpclientandroidlib.client;
|
|
|
|
import ch.boye.httpclientandroidlib.HttpHost;
|
|
import ch.boye.httpclientandroidlib.HttpRequest;
|
|
import ch.boye.httpclientandroidlib.HttpResponse;
|
|
import ch.boye.httpclientandroidlib.client.methods.HttpUriRequest;
|
|
import ch.boye.httpclientandroidlib.conn.ClientConnectionManager;
|
|
import ch.boye.httpclientandroidlib.params.HttpParams;
|
|
import ch.boye.httpclientandroidlib.protocol.HttpContext;
|
|
|
|
import java.io.IOException;
|
|
|
|
/**
|
|
* This interface represents only the most basic contract for HTTP request
|
|
* execution. It imposes no restrictions or particular details on the request
|
|
* execution process and leaves the specifics of state management,
|
|
* authentication and redirect handling up to individual implementations.
|
|
*
|
|
* @since 4.0
|
|
*/
|
|
@SuppressWarnings("deprecation")
|
|
public interface HttpClient {
|
|
|
|
|
|
/**
|
|
* Obtains the parameters for this client.
|
|
* These parameters will become defaults for all requests being
|
|
* executed with this client, and for the parameters of
|
|
* dependent objects in this client.
|
|
*
|
|
* @return the default parameters
|
|
*
|
|
* @deprecated (4.3) use
|
|
* {@link ch.boye.httpclientandroidlib.client.config.RequestConfig}.
|
|
*/
|
|
@Deprecated
|
|
HttpParams getParams();
|
|
|
|
/**
|
|
* Obtains the connection manager used by this client.
|
|
*
|
|
* @return the connection manager
|
|
*
|
|
* @deprecated (4.3) use
|
|
* {@link ch.boye.httpclientandroidlib.impl.client.HttpClientBuilder}.
|
|
*/
|
|
@Deprecated
|
|
ClientConnectionManager getConnectionManager();
|
|
|
|
/**
|
|
* Executes HTTP request using the default context.
|
|
*
|
|
* @param request the request to execute
|
|
*
|
|
* @return the response to the request. This is always a final response,
|
|
* never an intermediate response with an 1xx status code.
|
|
* Whether redirects or authentication challenges will be returned
|
|
* or handled automatically depends on the implementation and
|
|
* configuration of this client.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
HttpResponse execute(HttpUriRequest request)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request using the given context.
|
|
*
|
|
* @param request the request to execute
|
|
* @param context the context to use for the execution, or
|
|
* <code>null</code> to use the default context
|
|
*
|
|
* @return the response to the request. This is always a final response,
|
|
* never an intermediate response with an 1xx status code.
|
|
* Whether redirects or authentication challenges will be returned
|
|
* or handled automatically depends on the implementation and
|
|
* configuration of this client.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
HttpResponse execute(HttpUriRequest request, HttpContext context)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request using the default context.
|
|
*
|
|
* @param target the target host for the request.
|
|
* Implementations may accept <code>null</code>
|
|
* if they can still determine a route, for example
|
|
* to a default target or by inspecting the request.
|
|
* @param request the request to execute
|
|
*
|
|
* @return the response to the request. This is always a final response,
|
|
* never an intermediate response with an 1xx status code.
|
|
* Whether redirects or authentication challenges will be returned
|
|
* or handled automatically depends on the implementation and
|
|
* configuration of this client.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
HttpResponse execute(HttpHost target, HttpRequest request)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request using the given context.
|
|
*
|
|
* @param target the target host for the request.
|
|
* Implementations may accept <code>null</code>
|
|
* if they can still determine a route, for example
|
|
* to a default target or by inspecting the request.
|
|
* @param request the request to execute
|
|
* @param context the context to use for the execution, or
|
|
* <code>null</code> to use the default context
|
|
*
|
|
* @return the response to the request. This is always a final response,
|
|
* never an intermediate response with an 1xx status code.
|
|
* Whether redirects or authentication challenges will be returned
|
|
* or handled automatically depends on the implementation and
|
|
* configuration of this client.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
HttpResponse execute(HttpHost target, HttpRequest request,
|
|
HttpContext context)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request using the default context and processes the
|
|
* response using the given response handler.
|
|
* <p/>
|
|
* Implementing classes are required to ensure that the content entity
|
|
* associated with the response is fully consumed and the underlying
|
|
* connection is released back to the connection manager automatically
|
|
* in all cases relieving individual {@link ResponseHandler}s from
|
|
* having to manage resource deallocation internally.
|
|
*
|
|
* @param request the request to execute
|
|
* @param responseHandler the response handler
|
|
*
|
|
* @return the response object as generated by the response handler.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
<T> T execute(
|
|
HttpUriRequest request,
|
|
ResponseHandler<? extends T> responseHandler)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request using the given context and processes the
|
|
* response using the given response handler.
|
|
* <p/>
|
|
* Implementing classes are required to ensure that the content entity
|
|
* associated with the response is fully consumed and the underlying
|
|
* connection is released back to the connection manager automatically
|
|
* in all cases relieving individual {@link ResponseHandler}s from
|
|
* having to manage resource deallocation internally.
|
|
*
|
|
* @param request the request to execute
|
|
* @param responseHandler the response handler
|
|
* @param context the context to use for the execution, or
|
|
* <code>null</code> to use the default context
|
|
*
|
|
* @return the response object as generated by the response handler.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
<T> T execute(
|
|
HttpUriRequest request,
|
|
ResponseHandler<? extends T> responseHandler,
|
|
HttpContext context)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request to the target using the default context and
|
|
* processes the response using the given response handler.
|
|
* <p/>
|
|
* Implementing classes are required to ensure that the content entity
|
|
* associated with the response is fully consumed and the underlying
|
|
* connection is released back to the connection manager automatically
|
|
* in all cases relieving individual {@link ResponseHandler}s from
|
|
* having to manage resource deallocation internally.
|
|
*
|
|
* @param target the target host for the request.
|
|
* Implementations may accept <code>null</code>
|
|
* if they can still determine a route, for example
|
|
* to a default target or by inspecting the request.
|
|
* @param request the request to execute
|
|
* @param responseHandler the response handler
|
|
*
|
|
* @return the response object as generated by the response handler.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
<T> T execute(
|
|
HttpHost target,
|
|
HttpRequest request,
|
|
ResponseHandler<? extends T> responseHandler)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
/**
|
|
* Executes HTTP request to the target using the given context and
|
|
* processes the response using the given response handler.
|
|
* <p/>
|
|
* Implementing classes are required to ensure that the content entity
|
|
* associated with the response is fully consumed and the underlying
|
|
* connection is released back to the connection manager automatically
|
|
* in all cases relieving individual {@link ResponseHandler}s from
|
|
* having to manage resource deallocation internally.
|
|
*
|
|
* @param target the target host for the request.
|
|
* Implementations may accept <code>null</code>
|
|
* if they can still determine a route, for example
|
|
* to a default target or by inspecting the request.
|
|
* @param request the request to execute
|
|
* @param responseHandler the response handler
|
|
* @param context the context to use for the execution, or
|
|
* <code>null</code> to use the default context
|
|
*
|
|
* @return the response object as generated by the response handler.
|
|
* @throws IOException in case of a problem or the connection was aborted
|
|
* @throws ClientProtocolException in case of an http protocol error
|
|
*/
|
|
<T> T execute(
|
|
HttpHost target,
|
|
HttpRequest request,
|
|
ResponseHandler<? extends T> responseHandler,
|
|
HttpContext context)
|
|
throws IOException, ClientProtocolException;
|
|
|
|
}
|