Modifier and Type	Class and Description
public static class	HttpServiceProxyFactory.Builder Builder to create an `HttpServiceProxyFactory`.
private static class	HttpServiceProxyFactory.HttpServiceMethodInterceptor `MethodInterceptor` that invokes an `HttpServiceMethod`.

Modifier and Type	Field and Description
private final List<HttpServiceArgumentResolver>	argumentResolvers
private final StringValueResolver	embeddedValueResolver
private final HttpExchangeAdapter	exchangeAdapter

Access	Constructor and Description
private	HttpServiceProxyFactory(HttpExchangeAdapter exchangeAdapter, List<HttpServiceArgumentResolver> argumentResolvers, StringValueResolver embeddedValueResolver)

Modifier and Type	Method and Description
public static HttpServiceProxyFactory.Builder	builder(HttpClientAdapter clientAdapter) Deprecated for removal since 6.1. in favor of `builderFor(HttpExchangeAdapter)`; to be removed in 6.2. Return a builder that's initialized with the given client.
public static HttpServiceProxyFactory.Builder	builder() Return an empty builder, with the client to be provided to builder.
public static HttpServiceProxyFactory.Builder	builderFor(HttpExchangeAdapter exchangeAdapter) Return a builder that's initialized with the given client.
public < the HTTP service type S> S	Returns: the created proxy createClient(Class<S> the HTTP service to create a proxy for serviceType) Return a proxy that implements the given HTTP service interface to perform HTTP requests and retrieve responses through an HTTP client.
private <S> HttpServiceMethod	createHttpServiceMethod(Class<S> serviceType, Method method)
private boolean	isExchangeMethod(Method method)

argumentResolvers	back to summary
private final List<HttpServiceArgumentResolver> argumentResolvers

embeddedValueResolver	back to summary
private final StringValueResolver embeddedValueResolver Annotations @Nullable

exchangeAdapter	back to summary
private final HttpExchangeAdapter exchangeAdapter

HttpServiceProxyFactory	back to summary
private HttpServiceProxyFactory(HttpExchangeAdapter exchangeAdapter, List<HttpServiceArgumentResolver> argumentResolvers, StringValueResolver embeddedValueResolver)

builder	back to summary
public static HttpServiceProxyFactory.Builder builder(HttpClientAdapter clientAdapter) Deprecated for removal since 6.1. in favor of `builderFor(HttpExchangeAdapter)`; to be removed in 6.2. Return a builder that's initialized with the given client. Annotations @SuppressWarnings:removal @Deprecated since:6.1 forRemoval:true

builder	back to summary
public static HttpServiceProxyFactory.Builder builder() Return an empty builder, with the client to be provided to builder.

builderFor	back to summary
public static HttpServiceProxyFactory.Builder builderFor(HttpExchangeAdapter exchangeAdapter) Return a builder that's initialized with the given client. Since 6.1

createClient	back to summary
public <S> S createClient(Class<S> serviceType) Return a proxy that implements the given HTTP service interface to perform HTTP requests and retrieve responses through an HTTP client. Parameters <S> the HTTP service type serviceType:Class<S> the HTTP service to create a proxy for Returns:S the created proxy

createHttpServiceMethod	back to summary
private <S> HttpServiceMethod createHttpServiceMethod(Class<S> serviceType, Method method)

isExchangeMethod	back to summary
private boolean isExchangeMethod(Method method)

org.springframework.web.service.invoker back to summary

public final Class HttpServiceProxyFactory.Builder

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder

Builder to create an HttpServiceProxyFactory.

Field Summary

Modifier and Type	Field and Description
private ConversionService	conversionService
private final List<HttpServiceArgumentResolver>	customArgumentResolvers
private StringValueResolver	embeddedValueResolver
private HttpExchangeAdapter	exchangeAdapter

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public HttpServiceProxyFactory.Builder	Returns: this same builder instance blockTimeout(Duration the timeout value blockTimeout) Deprecated for removal since 6.1. 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.
public HttpServiceProxyFactory	build() Build the `HttpServiceProxyFactory` instance.
public HttpServiceProxyFactory.Builder	Returns: this same builder instance clientAdapter(HttpClientAdapter a client adapted to `HttpClientAdapter` clientAdapter) Deprecated for removal since 6.1. in favor of `exchangeAdapter(HttpExchangeAdapter)`; to be removed in 6.2 Provide the HTTP client to perform requests through.
public HttpServiceProxyFactory.Builder	Returns: this same builder instance conversionService(ConversionService conversionService) Set the `ConversionService` to use where input values need to be formatted as Strings.
public HttpServiceProxyFactory.Builder	Returns: this same builder instance customArgumentResolver(HttpServiceArgumentResolver the resolver to add resolver) Register a custom argument resolver, invoked ahead of default resolvers.
public HttpServiceProxyFactory.Builder	Returns: this same builder instance embeddedValueResolver(StringValueResolver the resolver to use embeddedValueResolver) Set the `StringValueResolver` to use for resolving placeholders and expressions embedded in `HttpExchange#url()`.
public HttpServiceProxyFactory.Builder	Returns: this same builder instance exchangeAdapter(HttpExchangeAdapter a client adapted to `HttpExchangeAdapter` adapter) Provide the HTTP client to perform requests through.
private List<HttpServiceArgumentResolver>	initArgumentResolvers()
public HttpServiceProxyFactory.Builder	Returns: this same builder instance reactiveAdapterRegistry(ReactiveAdapterRegistry registry) Deprecated for removal since 6.1. 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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

conversionService	back to summary
private ConversionService conversionService Annotations @Nullable

customArgumentResolvers	back to summary
private final List<HttpServiceArgumentResolver> customArgumentResolvers

embeddedValueResolver	back to summary
private StringValueResolver embeddedValueResolver Annotations @Nullable

exchangeAdapter	back to summary
private HttpExchangeAdapter exchangeAdapter Annotations @Nullable

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

blockTimeout back to summary

blockTimeout	back to summary
public HttpServiceProxyFactory.Builder blockTimeout(Duration blockTimeout) Deprecated for removal since 6.1. 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:Duration the timeout value Returns:HttpServiceProxyFactory.Builder this same builder instance Annotations @Deprecated since:6.1 forRemoval:true

public HttpServiceProxyFactory.Builder blockTimeout(Duration blockTimeout)

Deprecated

for removal since 6.1.

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:Duration: the timeout value

Returns:HttpServiceProxyFactory.Builder

this same builder instance

Annotations

@Deprecated
since:6.1
forRemoval:true

build	back to summary
public HttpServiceProxyFactory build() Build the `HttpServiceProxyFactory` instance.

clientAdapter back to summary

clientAdapter	back to summary
public HttpServiceProxyFactory.Builder clientAdapter(HttpClientAdapter clientAdapter) Deprecated for removal since 6.1. in favor of `exchangeAdapter(HttpExchangeAdapter)`; to be removed in 6.2 Provide the HTTP client to perform requests through. Parameters clientAdapter:HttpClientAdapter a client adapted to `HttpClientAdapter` Returns:HttpServiceProxyFactory.Builder this same builder instance Annotations @SuppressWarnings:removal @Deprecated since:6.1 forRemoval:true

public HttpServiceProxyFactory.Builder clientAdapter(HttpClientAdapter clientAdapter)

Deprecated

for removal since 6.1.

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

Provide the HTTP client to perform requests through.

Parameters

clientAdapter:HttpClientAdapter: a client adapted to HttpClientAdapter

Returns:HttpServiceProxyFactory.Builder

this same builder instance

Annotations

@SuppressWarnings:removal
@Deprecated
since:6.1
forRemoval:true

conversionService back to summary

conversionService	back to summary
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:HttpServiceProxyFactory.Builder this same builder instance

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:HttpServiceProxyFactory.Builder: this same builder instance

customArgumentResolver	back to summary
public HttpServiceProxyFactory.Builder customArgumentResolver(HttpServiceArgumentResolver resolver) Register a custom argument resolver, invoked ahead of default resolvers. Parameters resolver:HttpServiceArgumentResolver the resolver to add Returns:HttpServiceProxyFactory.Builder this same builder instance

customArgumentResolver

back to summary

public HttpServiceProxyFactory.Builder customArgumentResolver(HttpServiceArgumentResolver resolver)

Parameters

resolver:HttpServiceArgumentResolver: the resolver to add

Returns:HttpServiceProxyFactory.Builder

this same builder instance

embeddedValueResolver back to summary

embeddedValueResolver	back to summary
public HttpServiceProxyFactory.Builder embeddedValueResolver(StringValueResolver embeddedValueResolver) Set the `StringValueResolver` to use for resolving placeholders and expressions embedded in `HttpExchange#url()`. Parameters embeddedValueResolver:StringValueResolver the resolver to use Returns:HttpServiceProxyFactory.Builder this same builder instance

public HttpServiceProxyFactory.Builder embeddedValueResolver(StringValueResolver embeddedValueResolver)

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

Parameters

embeddedValueResolver:StringValueResolver: the resolver to use

Returns:HttpServiceProxyFactory.Builder

this same builder instance

exchangeAdapter back to summary

exchangeAdapter	back to summary
public HttpServiceProxyFactory.Builder exchangeAdapter(HttpExchangeAdapter adapter) Provide the HTTP client to perform requests through. Parameters adapter:HttpExchangeAdapter a client adapted to `HttpExchangeAdapter` Returns:HttpServiceProxyFactory.Builder this same builder instance Since 6.1

public HttpServiceProxyFactory.Builder exchangeAdapter(HttpExchangeAdapter adapter)

Provide the HTTP client to perform requests through.

Parameters

adapter:HttpExchangeAdapter: a client adapted to HttpExchangeAdapter

Returns:HttpServiceProxyFactory.Builder

this same builder instance

Since

6.1

initArgumentResolvers	back to summary
private List<HttpServiceArgumentResolver> initArgumentResolvers() Annotations @SuppressWarnings:DataFlowIssue

reactiveAdapterRegistry back to summary

reactiveAdapterRegistry	back to summary
public HttpServiceProxyFactory.Builder reactiveAdapterRegistry(ReactiveAdapterRegistry registry) Deprecated for removal since 6.1. 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:HttpServiceProxyFactory.Builder this same builder instance Annotations @Deprecated since:6.1 forRemoval:true

public HttpServiceProxyFactory.Builder reactiveAdapterRegistry(ReactiveAdapterRegistry registry)

Deprecated

for removal since 6.1.

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:HttpServiceProxyFactory.Builder

this same builder instance

Annotations

@Deprecated
since:6.1
forRemoval:true

org.springframework.web.service.invoker back to summary

private final Class HttpServiceProxyFactory.HttpServiceMethodInterceptor

Class Inheritance

extends Object
implements MethodInterceptor

java.lang.Object
org.springframework.web.service.invoker.HttpServiceProxyFactory.HttpServiceMethodInterceptor

All Implemented Interfaces

org.aopalliance.intercept.MethodInterceptor, org.aopalliance.intercept.Interceptor, org.aopalliance.aop.Advice

MethodInterceptor that invokes an HttpServiceMethod.

Field Summary

Modifier and Type	Field and Description
private final Map<Method, HttpServiceMethod>	httpServiceMethods

Constructor Summary

Access	Constructor and Description
private	HttpServiceMethodInterceptor(List<HttpServiceMethod> methods)

Method Summary

Modifier and Type	Method and Description
public Object	invoke(MethodInvocation the method invocation joinpoint invocation) Implements org.aopalliance.intercept.MethodInterceptor.invoke. Implement this method to perform extra treatments before and after the invocation.
private static Object[]	resolveCoroutinesArguments(Object[] args)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

httpServiceMethods	back to summary
private final Map<Method, HttpServiceMethod> httpServiceMethods

Constructor Detail

HttpServiceMethodInterceptor	back to summary
private HttpServiceMethodInterceptor(List<HttpServiceMethod> methods)

Method Detail

invoke back to summary

invoke	back to summary
public Object invoke(MethodInvocation invocation) throws Throwable Implements org.aopalliance.intercept.MethodInterceptor.invoke. Doc from org.aopalliance.intercept.MethodInterceptor.invoke. Implement this method to perform extra treatments before and after the invocation. Polite implementations would certainly like to invoke `Joinpoint#proceed()`. Parameters invocation:MethodInvocation the method invocation joinpoint Returns:Object the result of the call to `Joinpoint#proceed()`; might be intercepted by the interceptor Annotations @Override Exceptions Throwable: if the interceptors or the target object throws an exception

public Object invoke(MethodInvocation invocation) throws Throwable

Implements org.aopalliance.intercept.MethodInterceptor.invoke.

Doc from org.aopalliance.intercept.MethodInterceptor.invoke.

Implement this method to perform extra treatments before and after the invocation. Polite implementations would certainly like to invoke Joinpoint#proceed().

Parameters

invocation:MethodInvocation: the method invocation joinpoint

Returns:Object

the result of the call to Joinpoint#proceed(); might be intercepted by the interceptor

Annotations

@Override

Exceptions

Throwable:: if the interceptors or the target object throws an exception

resolveCoroutinesArguments	back to summary
private static Object[] resolveCoroutinesArguments(Object[] args)

public final Class HttpServiceProxyFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class HttpServiceProxyFactory.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpServiceProxyFactory.HttpServiceMethodInterceptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail