001/*
002 * Copyright 2002-2014 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.http.client;
018
019import java.io.IOException;
020import java.net.URI;
021
022import org.springframework.http.HttpMethod;
023
024/**
025 * Factory for {@link AsyncClientHttpRequest} objects.
026 * Requests are created by the {@link #createAsyncRequest(URI, HttpMethod)} method.
027 *
028 * @author Arjen Poutsma
029 * @since 4.0
030 */
031public interface AsyncClientHttpRequestFactory {
032
033        /**
034         * Create a new asynchronous {@link AsyncClientHttpRequest} for the specified URI
035         * and HTTP method.
036         * <p>The returned request can be written to, and then executed by calling
037         * {@link AsyncClientHttpRequest#executeAsync()}.
038         * @param uri the URI to create a request for
039         * @param httpMethod the HTTP method to execute
040         * @return the created request
041         * @throws IOException in case of I/O errors
042         */
043        AsyncClientHttpRequest createAsyncRequest(URI uri, HttpMethod httpMethod) throws IOException;
044
045}