Module org.refcodes.web

Package org.refcodes.web

Interface HttpServerInterceptable

All Superinterfaces:

PostHttpInterceptable<PostHttpServerInterceptor>, PostHttpServerInterceptable, PreHttpInterceptable<PreHttpServerInterceptor>, PreHttpServerInterceptable

public interface HttpServerInterceptable
extends PreHttpServerInterceptable, PostHttpServerInterceptable

The HttpServerInterceptable provides base functionality for working with HttpServerInterceptor instances using the PreHttpServerInterceptable as well as the PostHttpServerInterceptable definitions.

Method Summary

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

Tests whether the given HttpServerInterceptor instance has been added.

Parameters:

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

Returns:

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

addHttpInterceptor

default boolean addHttpInterceptor(HttpServerInterceptor aInterceptor)

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

Parameters:

aInterceptor - The HttpServerInterceptor instance which is to be added.

Returns:

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

removeHttpInterceptor

default boolean removeHttpInterceptor(HttpServerInterceptor aInterceptor)

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

Parameters:

aInterceptor - The HttpServerInterceptor instance which is to be removed.

Returns:

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