Package org.springframework.web.service.invoker

Class HttpServiceProxyFactory.Builder

java.lang.Object

org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder

Enclosing class:

HttpServiceProxyFactory

public static final class HttpServiceProxyFactory.Builder
extends Object

Builder to create an HttpServiceProxyFactory.

Method Summary

Modifier and Type	Method	Description
HttpServiceProxyFactory.Builder	blockTimeout(Duration blockTimeout)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of setting the same directly on the HttpExchangeAdapter
HttpServiceProxyFactory	build()	Build the HttpServiceProxyFactory instance.
HttpServiceProxyFactory.Builder	clientAdapter(HttpClientAdapter clientAdapter)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of exchangeAdapter(HttpExchangeAdapter); to be removed in 6.2
HttpServiceProxyFactory.Builder	conversionService(ConversionService conversionService)	Set the ConversionService to use where input values need to be formatted as Strings.
HttpServiceProxyFactory.Builder	customArgumentResolver(HttpServiceArgumentResolver resolver)	Register a custom argument resolver, invoked ahead of default resolvers.
HttpServiceProxyFactory.Builder	embeddedValueResolver(StringValueResolver embeddedValueResolver)	Set the StringValueResolver to use for resolving placeholders and expressions embedded in HttpExchange.url().
HttpServiceProxyFactory.Builder	exchangeAdapter(HttpExchangeAdapter adapter)	Provide the HTTP client to perform requests through.
HttpServiceProxyFactory.Builder	reactiveAdapterRegistry(ReactiveAdapterRegistry registry)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of setting the same directly on the HttpExchangeAdapter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

exchangeAdapter

public HttpServiceProxyFactory.Builder exchangeAdapter(HttpExchangeAdapter adapter)

Provide the HTTP client to perform requests through.

Parameters:

adapter - a client adapted to HttpExchangeAdapter

Returns:

this same builder instance

Since:

6.1

clientAdapter

@Deprecated(since="6.1",
            forRemoval=true)
public HttpServiceProxyFactory.Builder clientAdapter(HttpClientAdapter clientAdapter)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of exchangeAdapter(HttpExchangeAdapter); to be removed in 6.2

Provide the HTTP client to perform requests through.

Parameters:

clientAdapter - a client adapted to HttpClientAdapter

Returns:

this same builder instance

customArgumentResolver

public HttpServiceProxyFactory.Builder customArgumentResolver(HttpServiceArgumentResolver resolver)

Register a custom argument resolver, invoked ahead of default resolvers.

Parameters:

resolver - the resolver to add

Returns:

this same builder instance

conversionService

public HttpServiceProxyFactory.Builder conversionService(ConversionService conversionService)

Set the ConversionService to use where input values need to be formatted as Strings.

By default this is DefaultFormattingConversionService.

Returns:

this same builder instance

embeddedValueResolver

public HttpServiceProxyFactory.Builder embeddedValueResolver(StringValueResolver embeddedValueResolver)

Set the StringValueResolver to use for resolving placeholders and expressions embedded in HttpExchange.url().

Parameters:

embeddedValueResolver - the resolver to use

Returns:

this same builder instance

reactiveAdapterRegistry

@Deprecated(since="6.1",
            forRemoval=true)
public HttpServiceProxyFactory.Builder reactiveAdapterRegistry(ReactiveAdapterRegistry registry)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of setting the same directly on the HttpExchangeAdapter

Set the ReactiveAdapterRegistry to use to support different asynchronous types for HTTP service method return values.

By default this is ReactiveAdapterRegistry.getSharedInstance().

Returns:

this same builder instance

blockTimeout

@Deprecated(since="6.1",
            forRemoval=true)
public HttpServiceProxyFactory.Builder blockTimeout(@Nullable
 Duration blockTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of setting the same directly on the HttpExchangeAdapter

Configure how long to block for the response of an HTTP service method with a synchronous (blocking) method signature.

By default this is not set, in which case the behavior depends on connection and request timeout settings of the underlying HTTP client. We recommend configuring timeout values directly on the underlying HTTP client, which provides more control over such settings.

Parameters:

blockTimeout - the timeout value

Returns:

this same builder instance

build

public HttpServiceProxyFactory build()

Build the HttpServiceProxyFactory instance.