/*
 * Copyright 2002-2015 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.net.URI;

import org.springframework.http.HttpMethod;
import org.springframework.util.Assert;

Abstract base class for ClientHttpRequestFactory implementations that decorate another request factory.
Author:Arjen Poutsma
Since:3.1
/** * Abstract base class for {@link ClientHttpRequestFactory} implementations * that decorate another request factory. * * @author Arjen Poutsma * @since 3.1 */
public abstract class AbstractClientHttpRequestFactoryWrapper implements ClientHttpRequestFactory { private final ClientHttpRequestFactory requestFactory;
Create a AbstractClientHttpRequestFactoryWrapper wrapping the given request factory.
Params:
  • requestFactory – the request factory to be wrapped
/** * Create a {@code AbstractClientHttpRequestFactoryWrapper} wrapping the given request factory. * @param requestFactory the request factory to be wrapped */
protected AbstractClientHttpRequestFactoryWrapper(ClientHttpRequestFactory requestFactory) { Assert.notNull(requestFactory, "ClientHttpRequestFactory must not be null"); this.requestFactory = requestFactory; }
This implementation simply calls createRequest(URI, HttpMethod, ClientHttpRequestFactory) with the wrapped request factory provided to the constructor.
/** * This implementation simply calls {@link #createRequest(URI, HttpMethod, ClientHttpRequestFactory)} * with the wrapped request factory provided to the * {@linkplain #AbstractClientHttpRequestFactoryWrapper(ClientHttpRequestFactory) constructor}. */
@Override public final ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException { return createRequest(uri, httpMethod, this.requestFactory); }
Create a new ClientHttpRequest for the specified URI and HTTP method by using the passed-on request factory.

Called from createRequest(URI, HttpMethod).

Params:
  • uri – the URI to create a request for
  • httpMethod – the HTTP method to execute
  • requestFactory – the wrapped request factory
Throws:
Returns:the created request
/** * Create a new {@link ClientHttpRequest} for the specified URI and HTTP method * by using the passed-on request factory. * <p>Called from {@link #createRequest(URI, HttpMethod)}. * @param uri the URI to create a request for * @param httpMethod the HTTP method to execute * @param requestFactory the wrapped request factory * @return the created request * @throws IOException in case of I/O errors */
protected abstract ClientHttpRequest createRequest( URI uri, HttpMethod httpMethod, ClientHttpRequestFactory requestFactory) throws IOException; }