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

Class AuthBasic

java.lang.Object

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

All Implemented Interfaces:

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

public class AuthBasic
extends java.lang.Object
implements Middleware

A Middleware allows limiting access to resources by validating the user name and password using the "HTTP Basic Authentication" protocol.

Since:

1.1

See Also:

Middleware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthBasic.BasicUser	A HttpServer.User holding the username parsed from the "HTTP Basic Authentication" protocol.

Constructor Summary

Constructors

Constructor	Description
AuthBasic(java.util.function.BiPredicate<java.lang.String,java.lang.String> validator, java.lang.String realm)	Constructs a new AuthBasic with the specified validator and realm.
AuthBasic(java.util.Map<java.lang.String,java.lang.String> users, java.lang.String realm)	Constructs a new AuthBasic with the specified users and realm.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletionStage<HttpResult>	apply(HttpRequestContext ctx, MiddlewareChain next)	Apply this Middleware to the given HttpRequestContext.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

AuthBasic

public AuthBasic(java.util.Map<java.lang.String,java.lang.String> users,
                 java.lang.String realm)

Constructs a new AuthBasic with the specified users and realm.

Parameters:

users - a map contains the users' name and their password

realm - the realm attribute

AuthBasic

public AuthBasic(java.util.function.BiPredicate<java.lang.String,java.lang.String> validator,
                 java.lang.String realm)

Constructs a new AuthBasic with the specified validator and realm.

Parameters:

validator - function to validating the user name and password

realm - the realm attribute

Method Detail

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>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object