Module org.refcodes.web

Package org.refcodes.web

Interface HttpClientInterceptable

All Superinterfaces:

PostHttpClientInterceptable, PostHttpInterceptable<PostHttpClientInterceptor>, PreHttpClientInterceptable, PreHttpInterceptable<PreHttpClientInterceptor>

public interface HttpClientInterceptable
extends PreHttpClientInterceptable, PostHttpClientInterceptable

The HttpClientInterceptable provides base functionality for working with HttpClientInterceptor instances using the PreHttpClientInterceptable as well as the PostHttpClientInterceptable definitions.

Method Summary

Modifier and Type	Method	Description
default boolean	addHttpInterceptor(HttpClientInterceptor aInterceptor)	Adds the given HttpClientInterceptor instance.
default boolean	hasHttpInterceptor(HttpClientInterceptor aInterceptor)	Tests whether the given HttpClientInterceptor instance has been added.
default boolean	removeHttpInterceptor(HttpClientInterceptor aInterceptor)	Removes the HttpClientInterceptor instance.

Methods inherited from interface org.refcodes.web.PostHttpInterceptable

addPostHttpInterceptor, hasPostHttpInterceptor, removePostHttpInterceptor

Methods inherited from interface org.refcodes.web.PreHttpInterceptable

addPreHttpInterceptor, hasPreHttpInterceptor, removePreHttpInterceptor

Method Details

hasHttpInterceptor

default boolean hasHttpInterceptor(HttpClientInterceptor aInterceptor)

Tests whether the given HttpClientInterceptor instance has been added.

Parameters:

aInterceptor - The HttpClientInterceptor instance for which to test if it has been added.

Returns:

True in case PreHttpInterceptable.hasPreHttpInterceptor(PreHttpInterceptor) as well as PostHttpInterceptable.hasPostHttpInterceptor(PostHttpInterceptor) return true.

addHttpInterceptor

default boolean addHttpInterceptor(HttpClientInterceptor aInterceptor)

Adds the given HttpClientInterceptor instance. The HttpClientInterceptor instance itself acts as the handle which is used when removing the given HttpClientInterceptor instance later.

Parameters:

aInterceptor - The HttpClientInterceptor instance which is to be added.

Returns:

True in case PreHttpInterceptable.addPreHttpInterceptor(PreHttpInterceptor) or PostHttpInterceptable.addPostHttpInterceptor(PostHttpInterceptor) return true.

removeHttpInterceptor

default boolean removeHttpInterceptor(HttpClientInterceptor aInterceptor)

Removes the HttpClientInterceptor instance. In case the HttpClientInterceptor instance has not been added before, then false is returned.

Parameters:

aInterceptor - The HttpClientInterceptor instance which is to be removed.

Returns:

True in case PreHttpInterceptable.removePreHttpInterceptor(PreHttpInterceptor) or PostHttpInterceptable.removePostHttpInterceptor(PostHttpInterceptor) return true.