Package io.micronaut.http.client.bind

Interface AnnotatedClientRequestBinder<A extends Annotation>

Type Parameters:

A - - the annotation type that this binder is applied with

All Superinterfaces:

ClientRequestBinder

All Known Implementing Classes:

AttributeClientRequestBinder, HeaderClientRequestBinder, VersionClientRequestBinder

@Indexed(AnnotatedClientRequestBinder.class)
public interface AnnotatedClientRequestBinder<A extends Annotation>
extends ClientRequestBinder

A binder that binds to a MutableHttpRequest. This binder is used when the annotation is applied to the whole method. In case of binder for arguments use ClientArgumentRequestBinder/

Since:

3.0.0

Author:

Andriy Dmytruk

Method Summary

Modifier and Type	Method	Description
void	bind(@NonNull MethodInvocationContext<Object,Object> context, @NonNull ClientRequestUriContext uriContext, @NonNull MutableHttpRequest<?> request)	Modify the request with the annotation that this binder is applied to.
@NonNull Class<A>	getAnnotationType()

Method Details

bind

void bind(@NonNull
 @NonNull MethodInvocationContext<Object,Object> context,
 @NonNull
 @NonNull ClientRequestUriContext uriContext,
 @NonNull
 @NonNull MutableHttpRequest<?> request)

Modify the request with the annotation that this binder is applied to. The URI cannot be changed. The query parameters from the uriContext remain in the resulting request.

Parameters:

context - The context of method invocation

uriContext - The URI context

request - The request

getAnnotationType

@NonNull
@NonNull Class<A> getAnnotationType()

Returns:

The annotation type.