Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface ErrorWebInterceptorManager<A extends ExchangeContext,B extends ErrorWebInterceptable<A,B>>

Type Parameters:

A - the type of the exchange context

B - the type of Error Web interceptable

All Superinterfaces:

ErrorInterceptorManager<A,ErrorWebExchange<A>,B,ErrorWebInterceptorManager<A,B>>, InterceptorManager<A,ErrorWebExchange<A>,B,ErrorWebInterceptorManager<A,B>>

public interface ErrorWebInterceptorManager<A extends ExchangeContext,B extends ErrorWebInterceptable<A,B>>
extends ErrorInterceptorManager<A,ErrorWebExchange<A>,B,ErrorWebInterceptorManager<A,B>>

An error web interceptor manager is used to define interceptors in an error web router.

It is created by an error web router and allows to define interceptors in an error web intercepted router.

Since:

1.5

Author:

Jeremy Kuhn

Method Summary

Modifier and Type	Method	Description
ErrorWebInterceptorManager<A,B>	consumes(String mediaRange)	Specifies the media range defining the content types accepted by the route to intercept as defined by RFC 7231 Section 5.3.2.
B	interceptor(ExchangeInterceptor<? super A,ErrorWebExchange<A>> interceptor)	Specifies an error web exchange interceptor to apply to the resources matching the criteria defined in the web interceptor manager.
B	interceptors(List<ExchangeInterceptor<? super A,ErrorWebExchange<A>>> interceptors)	Specifies multiple error web exchange interceptors to apply to the resources matching the criteria defined in the web interceptor manager.
ErrorWebInterceptorManager<A,B>	language(String languageRange)	Specifies the language range matching the language tag produced by the route to intercept.
default ErrorWebInterceptorManager<A,B>	path(String path)	Specifies the path without matching trailing slash to the route to intercept.
ErrorWebInterceptorManager<A,B>	path(String path, boolean matchTrailingSlash)	Specifies the path matching or not trailing slash to the route to intercept.
ErrorWebInterceptorManager<A,B>	produces(String mediaRange)	Specifies the media range matching the content type produced by the route to intercept.

Methods inherited from interface io.inverno.mod.web.server.spi.ErrorInterceptorManager

error

Method Details

interceptor

B interceptor(ExchangeInterceptor<? super A,ErrorWebExchange<A>> interceptor)

Specifies an error web exchange interceptor to apply to the resources matching the criteria defined in the web interceptor manager.

This method basically appends the interceptor and the associated route criteria to the web intercepted router it comes from.

Specified by:

interceptor in interface InterceptorManager<A extends ExchangeContext,ErrorWebExchange<A extends ExchangeContext>,B extends ErrorWebInterceptable<A,B>,ErrorWebInterceptorManager<A extends ExchangeContext,B extends ErrorWebInterceptable<A,B>>>

Parameters:

interceptor - the error web exchange interceptor

Returns:

the error router

interceptors

B interceptors(List<ExchangeInterceptor<? super A,ErrorWebExchange<A>>> interceptors)

Specifies multiple error web exchange interceptors to apply to the resources matching the criteria defined in the web interceptor manager.

This method basically appends the interceptors and the associated route criteria to the web intercepted router it comes from.

Specified by:

interceptors in interface InterceptorManager<A extends ExchangeContext,ErrorWebExchange<A extends ExchangeContext>,B extends ErrorWebInterceptable<A,B>,ErrorWebInterceptorManager<A extends ExchangeContext,B extends ErrorWebInterceptable<A,B>>>

Parameters:

interceptors - a list of error web exchange interceptors

Returns:

the error router

path

default ErrorWebInterceptorManager<A,B> path(String path)
                                      throws IllegalArgumentException

Specifies the path without matching trailing slash to the route to intercept.

The specified path can be specified as a parameterized path and include path pattern like ?, *, ** as defined by URIBuilder. Note that this path is only meant to filter routes and as a result path parameters have no use.

Parameters:

path - a path

Returns:

the error web interceptor manager

Throws:

IllegalArgumentException - if the specified path is not absolute

See Also:

• PathAware

path

ErrorWebInterceptorManager<A,B> path(String path,
 boolean matchTrailingSlash)
                              throws IllegalArgumentException

Specifies the path matching or not trailing slash to the route to intercept.

The specified path can be specified as a parameterized path and include path pattern like ?, *, ** as defined by URIBuilder. Note that this path is only meant to filter routes and as a result path parameters have no use.

Parameters:

path - a path

matchTrailingSlash - true to match path with or without trailing slash, false otherwise

Returns:

the error web interceptor manager

Throws:

IllegalArgumentException - if the specified path is not absolute

See Also:

• PathAware

consumes

ErrorWebInterceptorManager<A,B> consumes(String mediaRange)

Specifies the media range defining the content types accepted by the route to intercept as defined by RFC 7231 Section 5.3.2.

Parameters:

mediaRange - a media range

Returns:

the web interceptor manager

See Also:

• ContentAware

produces

ErrorWebInterceptorManager<A,B> produces(String mediaRange)

Specifies the media range matching the content type produced by the route to intercept.

Parameters:

mediaRange - a media range

Returns:

the error web interceptor manager

See Also:

• AcceptAware

language

ErrorWebInterceptorManager<A,B> language(String languageRange)

Specifies the language range matching the language tag produced by the route to intercept.

Parameters:

languageRange - a language range

Returns:

the error web interceptor manager

See Also:

• AcceptAware