Package com.github.fmjsjx.libnetty.http.server.middleware

Class PathFilterMiddleware

java.lang.Object

com.github.fmjsjx.libnetty.http.server.middleware.PathFilterMiddleware

All Implemented Interfaces:

Middleware, java.util.function.BiFunction<HttpRequestContext,MiddlewareChain,java.util.concurrent.CompletionStage<HttpResult>>

public class PathFilterMiddleware
extends java.lang.Object
implements Middleware

Delegating a Middleware with a path filter.

The delegated Middleware only effective when the path filter returns true.

Since:

1.1

Constructor Summary

Constructors

Constructor	Description
PathFilterMiddleware(java.util.function.Predicate<java.lang.String> pathFilter, Middleware delegated)	Constructs a new PathFilterMiddleware with the specified pathFilter and delegated Middleware.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletionStage<HttpResult>	apply(HttpRequestContext ctx, MiddlewareChain next)	Apply this Middleware to the given HttpRequestContext.
static java.util.function.Predicate<java.lang.String>	toFilter(java.lang.String... pathPrefixes)	Convert path prefixes to path filter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface com.github.fmjsjx.libnetty.http.server.middleware.Middleware

close, onServerClosed

Constructor Detail

PathFilterMiddleware

public PathFilterMiddleware(java.util.function.Predicate<java.lang.String> pathFilter,
                            Middleware delegated)

Constructs a new PathFilterMiddleware with the specified pathFilter and delegated Middleware.

Parameters:

pathFilter - a Predicate filters the HTTP path

delegated - the delegated Middleware

Method Detail

toFilter

public static final java.util.function.Predicate<java.lang.String> toFilter(java.lang.String... pathPrefixes)

Convert path prefixes to path filter.

Parameters:

pathPrefixes - the prefixes of HTTP paths

Returns:

a Predicate<String>

apply

public java.util.concurrent.CompletionStage<HttpResult> apply(HttpRequestContext ctx,
                                                              MiddlewareChain next)

Description copied from interface: Middleware

Apply this Middleware to the given HttpRequestContext.

Specified by:

apply in interface java.util.function.BiFunction<HttpRequestContext,MiddlewareChain,java.util.concurrent.CompletionStage<HttpResult>>

Specified by:

apply in interface Middleware

Parameters:

ctx - the HttpRequestContext object of the current HTTP request

next - the MiddlewareChain for invoking the next Middleware

Returns:

a CompletionStage<HttpResult>