Module org.refcodes.web

Package org.refcodes.web

Interface HttpInterceptable<I extends HttpInterceptor<?,?>>

Type Parameters:

I - The type of HttpInterceptor to be managed.

All Superinterfaces:

PostHttpInterceptable<I>, PreHttpInterceptable<I>

public interface HttpInterceptable<I extends HttpInterceptor<?,?>>
extends PreHttpInterceptable<I>, PostHttpInterceptable<I>

The HttpInterceptable provides base functionality for working with HttpInterceptor instances using the PreHttpInterceptable as well as the PostHttpInterceptable definitions.

Method Summary

Modifier and Type	Method	Description
default boolean	addHttpInterceptor(I aInterceptor)	Adds the given HttpInterceptor instance.
default boolean	hasHttpInterceptor(I aInterceptor)	Tests whether the given HttpInterceptor instance has been added.
default boolean	removeHttpInterceptor(I aInterceptor)	Removes the HttpInterceptor 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(I aInterceptor)

Tests whether the given HttpInterceptor instance has been added.

Parameters:

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

Returns:

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

addHttpInterceptor

default boolean addHttpInterceptor(I aInterceptor)

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

Parameters:

aInterceptor - The HttpInterceptor instance which is to be added.

Returns:

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

removeHttpInterceptor

default boolean removeHttpInterceptor(I aInterceptor)

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

Parameters:

aInterceptor - The HttpInterceptor instance which is to be removed.

Returns:

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