Package io.micronaut.http.filter

Class BaseFilterProcessor<A extends Annotation>

java.lang.Object

io.micronaut.http.filter.BaseFilterProcessor<A>

Type Parameters:

A - Filter annotation type

All Implemented Interfaces:

BeanDefinitionProcessor<A>

Direct Known Subclasses:

DefaultHttpClientFilterResolver

@Internal
public abstract class BaseFilterProcessor<A extends Annotation>
extends Object
implements BeanDefinitionProcessor<A>

Base class for processing ServerFilter and ClientFilter beans.

Since:

4.0.0

Author:

Jonas Konrad

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseFilterProcessor.AsyncBodyBinder<T>	Interface that signals to FilterRunner that we should wait for the request body to arrive before running this binder.
protected static final record	BaseFilterProcessor.FilterMetadata

Constructor Summary

Constructors

Constructor	Description
BaseFilterProcessor(@Nullable BeanContext beanContext, Class<A> filterAnnotation)

Method Summary

Modifier and Type	Method	Description
protected abstract void	addFilter(Supplier<GenericHttpFilter> factory, AnnotationMetadata methodAnnotations, BaseFilterProcessor.FilterMetadata metadata)	Add a filter.
protected @NonNull List<String>	prependContextPath(@NonNull List<String> patterns)	Prepend server context path if necessary.
final void	process(BeanDefinition<?> beanDefinition, BeanContext beanContext)	The process method will be called for every bean annotated with the given annotation type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseFilterProcessor

public BaseFilterProcessor(@Nullable BeanContext beanContext,
 Class<A> filterAnnotation)

Method Details

process

public final void process(BeanDefinition<?> beanDefinition,
 BeanContext beanContext)

Description copied from interface: BeanDefinitionProcessor

The process method will be called for every bean annotated with the given annotation type.

Specified by:

process in interface BeanDefinitionProcessor<A extends Annotation>

Parameters:

beanDefinition - The bean definition

beanContext - The bean context

addFilter

protected abstract void addFilter(Supplier<GenericHttpFilter> factory,
 AnnotationMetadata methodAnnotations,
 BaseFilterProcessor.FilterMetadata metadata)

Add a filter.

Parameters:

factory - Factory that will create the filter instance

methodAnnotations - Annotations on the filter method

metadata - Filter metadata from class and method annotations

prependContextPath

protected @NonNull List<String> prependContextPath(@NonNull List<String> patterns)

Prepend server context path if necessary.

Parameters:

patterns - Input patterns

Returns:

Output patterns with server context path prepended