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

Class RequestValidator

java.lang.Object

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

All Implemented Interfaces:

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

public abstract class RequestValidator
extends java.lang.Object
implements Middleware

A Middleware validates HTTP requests.

Since:

1.2

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestValidator()
protected	RequestValidator(io.netty.handler.codec.http.HttpResponseStatus failureStatus)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletionStage<HttpResult>	apply(HttpRequestContext ctx, MiddlewareChain next)	Apply this Middleware to the given HttpRequestContext.
io.netty.handler.codec.http.HttpResponseStatus	failureStatus()	Returns the status when validation failed.
static RequestValidator	simple(java.util.function.Predicate<HttpRequestContext> validation)	Returns a new RequestValidator instance using the specified validation function.
static RequestValidator	simple(java.util.function.Predicate<HttpRequestContext> validation, io.netty.handler.codec.http.HttpResponseStatus failureStatus)	Returns a new RequestValidator instance using the specified validation function.
protected abstract boolean	validate(HttpRequestContext ctx)	Validate the HttpRequestContext.

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

RequestValidator

protected RequestValidator()

RequestValidator

protected RequestValidator(io.netty.handler.codec.http.HttpResponseStatus failureStatus)

Method Detail

simple

public static final RequestValidator simple(java.util.function.Predicate<HttpRequestContext> validation)

Returns a new RequestValidator instance using the specified validation function.

Parameters:

validation - the validation function

Returns:

a RequestValidator instance

simple

public static final RequestValidator simple(java.util.function.Predicate<HttpRequestContext> validation,
                                            io.netty.handler.codec.http.HttpResponseStatus failureStatus)

Returns a new RequestValidator instance using the specified validation function.

Parameters:

validation - the validation function

failureStatus - the failure status

Returns:

a RequestValidator instance

failureStatus

public final io.netty.handler.codec.http.HttpResponseStatus failureStatus()

Returns the status when validation failed.

Returns:

the status when validation failed

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>

validate

protected abstract boolean validate(HttpRequestContext ctx)

Validate the HttpRequestContext.

Returns true if the context is valid, false otherwise.

Parameters:

ctx - the HTTP request context

Returns:

true if the context is valid, false otherwise