Package org.glassfish.jersey.client.spi

Interface InvocationBuilderListener

@Beta
@Contract
@ConstrainedTo(CLIENT)
public interface InvocationBuilderListener

Implementations of this interface will be notified when a new Invocation.Builder is created. This will allow implementations to access the invocation builders, and is intended for global providers. For example, the Invocation.Builder properties can be accessed to set properties that are available on the ClientRequestContext.

In order for the InvocationBuilderListener to be called, the implementation of the interface needs to be registered on the Client the same way the ClientRequestFilter is registered, for instance. If multiple InvocationBuilderListeners are to be utilized, the order of execution is driven by the Priority, the lower the priority value, the higher the priority, the sooner the execution.

Since:

2.30

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InvocationBuilderListener.InvocationBuilderContext	An Invocation.Builder subset of setter methods.

Method Summary

Modifier and Type	Method	Description
void	onNewBuilder(InvocationBuilderListener.InvocationBuilderContext context)	Whenever an Invocation.Builder is created, (i.e. when WebTarget.request(), WebTarget.request(String...), WebTarget.request(MediaType...) is called), this method would be invoked.

Method Details

onNewBuilder

void onNewBuilder(InvocationBuilderListener.InvocationBuilderContext context)

Whenever an Invocation.Builder is created, (i.e. when WebTarget.request(), WebTarget.request(String...), WebTarget.request(MediaType...) is called), this method would be invoked.

Parameters:

context - the updated InvocationBuilderListener.InvocationBuilderContext.