/*
 * Copyright 2002-2017 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.http.client;

import java.io.IOException;
import java.io.OutputStream;

import org.springframework.http.HttpHeaders;
import org.springframework.util.Assert;
import org.springframework.util.concurrent.ListenableFuture;

Abstract base for AsyncClientHttpRequest that makes sure that headers and body are not written multiple times.
Author:Arjen Poutsma
Since:4.0
Deprecated:as of Spring 5.0, in favor of AbstractClientHttpRequest
/** * Abstract base for {@link AsyncClientHttpRequest} that makes sure that headers and body * are not written multiple times. * * @author Arjen Poutsma * @since 4.0 * @deprecated as of Spring 5.0, in favor of {@link org.springframework.http.client.reactive.AbstractClientHttpRequest} */
@Deprecated abstract class AbstractAsyncClientHttpRequest implements AsyncClientHttpRequest { private final HttpHeaders headers = new HttpHeaders(); private boolean executed = false; @Override public final HttpHeaders getHeaders() { return (this.executed ? HttpHeaders.readOnlyHttpHeaders(this.headers) : this.headers); } @Override public final OutputStream getBody() throws IOException { assertNotExecuted(); return getBodyInternal(this.headers); } @Override public ListenableFuture<ClientHttpResponse> executeAsync() throws IOException { assertNotExecuted(); ListenableFuture<ClientHttpResponse> result = executeInternal(this.headers); this.executed = true; return result; }
Asserts that this request has not been executed yet.
Throws:
/** * Asserts that this request has not been {@linkplain #executeAsync() executed} yet. * @throws IllegalStateException if this request has been executed */
protected void assertNotExecuted() { Assert.state(!this.executed, "ClientHttpRequest already executed"); }
Abstract template method that returns the body.
Params:
  • headers – the HTTP headers
Returns:the body output stream
/** * Abstract template method that returns the body. * @param headers the HTTP headers * @return the body output stream */
protected abstract OutputStream getBodyInternal(HttpHeaders headers) throws IOException;
Abstract template method that writes the given headers and content to the HTTP request.
Params:
  • headers – the HTTP headers
Returns:the response object for the executed request
/** * Abstract template method that writes the given headers and content to the HTTP request. * @param headers the HTTP headers * @return the response object for the executed request */
protected abstract ListenableFuture<ClientHttpResponse> executeInternal(HttpHeaders headers) throws IOException; }