services.moleculer.web.middleware

Class BasicAuthenticator

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.BasicAuthenticator

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants, BasicAuthProvider

public class BasicAuthenticator
extends HttpMiddleware
implements HttpConstants, BasicAuthProvider

Simple middleware that provides HTTP BASIC Authentication support. Sample:

 route.use(new BasicAuthenticator("user", "password"));
 

Field Summary

Fields

Modifier and Type	Field and Description
protected io.datatree.dom.Cache<java.lang.String,java.lang.String>	cache
protected int	maxCachedLogins Max number of cached logins (0 = disable caching)
protected BasicAuthProvider	provider Custom auth provider.
protected java.lang.String	realm Realm name (visible on login screen).
protected java.util.Map<java.lang.String,java.lang.String>	users

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Fields inherited from interface services.moleculer.web.common.HttpConstants

ACCEPT, ACCEPT_ENCODING, AUTHORIZATION, CACHE_CONTROL, CHUNKED, CLOSE, CONNECT, CONNECTION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TYPE, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, COOKIE, DEFLATE, DELETE, ETAG, GET, GZIP, HEAD, IF_NONE_MATCH, KEEP_ALIVE, LOCATION, META_CONTENT_TYPE, META_HEADERS, META_LOCALE, META_LOCATION, META_SESSION, META_STATUS, META_TEMPLATE, NO_CACHE, OPTIONS, PATCH, POST, PROPERTY_COOKIES, PROPERTY_SESSION_ID, PROPERTY_USER, PUT, SET_COOKIE, TRACE, TRANSFER_ENCODING, WWW_AUTHENTICATE, X_FORWARDED_FOR

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticator()
BasicAuthenticator(BasicAuthProvider authProvider)
BasicAuthenticator(BasicAuthProvider authProvider, int cachedLogins)
BasicAuthenticator(java.lang.String username, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
BasicAuthenticator	addUser(java.lang.String username, java.lang.String password)
boolean	authenticate(services.moleculer.ServiceBroker broker, java.lang.String username, java.lang.String password)
int	getMaxCachedLogins()
BasicAuthProvider	getProvider()
java.lang.String	getRealm()
java.util.Map<java.lang.String,java.lang.String>	getUsers()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
protected void	sendUnauthorized(WebResponse rsp)
void	setMaxCachedLogins(int cachedLogins)
void	setProvider(BasicAuthProvider authProvider)
void	setRealm(java.lang.String realm)
void	setUsers(java.util.Map<java.lang.String,java.lang.String> users)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, started, stopped

Methods inherited from class java.lang.Object

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

Field Detail

realm

protected java.lang.String realm

Realm name (visible on login screen).

provider

protected BasicAuthProvider provider

Custom auth provider.

maxCachedLogins

protected int maxCachedLogins

Max number of cached logins (0 = disable caching)

users

protected java.util.Map<java.lang.String,java.lang.String> users

cache

protected io.datatree.dom.Cache<java.lang.String,java.lang.String> cache

Constructor Detail

BasicAuthenticator

public BasicAuthenticator()

BasicAuthenticator

public BasicAuthenticator(BasicAuthProvider authProvider)

BasicAuthenticator

public BasicAuthenticator(BasicAuthProvider authProvider,
                          int cachedLogins)

BasicAuthenticator

public BasicAuthenticator(java.lang.String username,
                          java.lang.String password)

Method Detail

install

public RequestProcessor install(RequestProcessor next,
                                io.datatree.Tree config)

Specified by:

install in class HttpMiddleware

sendUnauthorized

protected void sendUnauthorized(WebResponse rsp)
                         throws java.lang.Exception

Throws:

java.lang.Exception

authenticate

public boolean authenticate(services.moleculer.ServiceBroker broker,
                            java.lang.String username,
                            java.lang.String password)

Specified by:

authenticate in interface BasicAuthProvider

addUser

public BasicAuthenticator addUser(java.lang.String username,
                                  java.lang.String password)

getRealm

public java.lang.String getRealm()

setRealm

public void setRealm(java.lang.String realm)

getProvider

public BasicAuthProvider getProvider()

setProvider

public void setProvider(BasicAuthProvider authProvider)

getMaxCachedLogins

public int getMaxCachedLogins()

setMaxCachedLogins

public void setMaxCachedLogins(int cachedLogins)

getUsers

public java.util.Map<java.lang.String,java.lang.String> getUsers()

setUsers

public void setUsers(java.util.Map<java.lang.String,java.lang.String> users)