io.vertx.ext.auth.impl

Class AuthServiceImpl

java.lang.Object

io.vertx.ext.auth.impl.AuthServiceImpl

All Implemented Interfaces:

Handler<Long>, AuthService

Direct Known Subclasses:

ShiroAuthServiceImpl

public class AuthServiceImpl
extends Object
implements AuthService, Handler<Long>

Author:

Tim Fox

Field Summary

Fields inherited from interface io.vertx.ext.auth.AuthService

DEFAULT_LOGIN_TIMEOUT, DEFAULT_REAPER_PERIOD

Constructor Summary

Constructors

Constructor and Description
AuthServiceImpl(Vertx vertx, AuthProvider provider)
AuthServiceImpl(Vertx vertx, String className)

Method Summary

Modifier and Type	Method and Description
void	handle(Long tid)
AuthService	hasPermission(String loginID, String permission, Handler<AsyncResult<Boolean>> resultHandler) Does the user have the specified permission?
AuthService	hasPermissions(String loginID, Set<String> permissions, Handler<AsyncResult<Boolean>> resultHandler) Does the user have the specified permissions?
AuthService	hasRole(String loginID, String role, Handler<AsyncResult<Boolean>> resultHandler) Does the user have the specified role?
AuthService	hasRoles(String loginID, Set<String> roles, Handler<AsyncResult<Boolean>> resultHandler) Does the user have the specified roles?
AuthService	login(JsonObject principal, JsonObject credentials, Handler<AsyncResult<String>> resultHandler) Authenticate (login) using the specified credentials.
AuthService	loginWithTimeout(JsonObject principal, JsonObject credentials, long timeout, Handler<AsyncResult<String>> resultHandler) Authenticate (login) using the specified credentials.
AuthService	logout(String loginID, Handler<AsyncResult<Void>> resultHandler) Logout the user
AuthService	refreshLoginSession(String loginID, Handler<AsyncResult<Void>> resultHandler) Refresh an existing login ID so it doesn't expire
AuthService	setReaperPeriod(long reaperPeriod) Set the reaper period - how often to check for expired logins, in ms.
void	start() Start the service
void	stop() Stop the service

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.auth.AuthService

create, createEventBusProxy, createFromClassName

Constructor Detail

AuthServiceImpl

public AuthServiceImpl(Vertx vertx,
                       AuthProvider provider)

AuthServiceImpl

public AuthServiceImpl(Vertx vertx,
                       String className)

Method Detail

login

public AuthService login(JsonObject principal,
                         JsonObject credentials,
                         Handler<AsyncResult<String>> resultHandler)

Description copied from interface: AuthService

Authenticate (login) using the specified credentials. The contents of the credentials depend on what the auth provider is expecting. The default login ID timeout will be used.

Specified by:

login in interface AuthService

Parameters:

principal - represents the unique id (e.g. username) of the user being logged in

credentials - the credentials - e.g. password

resultHandler - will be passed a failed result if login failed or will be passed a succeeded result containing the login ID (a string) if login was successful.

loginWithTimeout

public AuthService loginWithTimeout(JsonObject principal,
                                    JsonObject credentials,
                                    long timeout,
                                    Handler<AsyncResult<String>> resultHandler)

Description copied from interface: AuthService

Authenticate (login) using the specified credentials. The contents of the credentials depend on what the auth provider is expecting. The specified login ID timeout will be used.

Specified by:

loginWithTimeout in interface AuthService

Parameters:

principal - represents the unique id (e.g. username) of the user being logged in

credentials - the credentials

timeout - the login timeout to use, in ms

resultHandler - will be passed a failed result if login failed or will be passed a succeeded result containing the login ID (a string) if login was successful.

logout

public AuthService logout(String loginID,
                          Handler<AsyncResult<Void>> resultHandler)

Description copied from interface: AuthService

Logout the user

Specified by:

logout in interface AuthService

Parameters:

loginID - the login ID as provided by AuthService.login(io.vertx.core.json.JsonObject, io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>>).

resultHandler - will be called with success or failure

refreshLoginSession

public AuthService refreshLoginSession(String loginID,
                                       Handler<AsyncResult<Void>> resultHandler)

Description copied from interface: AuthService

Refresh an existing login ID so it doesn't expire

Specified by:

refreshLoginSession in interface AuthService

Parameters:

loginID - the login ID as provided by AuthService.login(io.vertx.core.json.JsonObject, io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>>).

resultHandler - will be called with success or failure

hasRole

public AuthService hasRole(String loginID,
                           String role,
                           Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: AuthService

Does the user have the specified role?

Specified by:

hasRole in interface AuthService

Parameters:

loginID - the login ID as provided by AuthService.login(io.vertx.core.json.JsonObject, io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>>).

role - the role

resultHandler - will be called with the result - true if has role, false if not

hasPermission

public AuthService hasPermission(String loginID,
                                 String permission,
                                 Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: AuthService

Does the user have the specified permission?

Specified by:

hasPermission in interface AuthService

Parameters:

loginID - the login ID as provided by AuthService.login(io.vertx.core.json.JsonObject, io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>>).

permission - the permission

resultHandler - will be called with the result - true if has permission, false if not

hasRoles

public AuthService hasRoles(String loginID,
                            Set<String> roles,
                            Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: AuthService

Does the user have the specified roles?

Specified by:

hasRoles in interface AuthService

Parameters:

loginID - the login ID as provided by AuthService.login(io.vertx.core.json.JsonObject, io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>>).

roles - the set of roles

resultHandler - will be called with the result - true if has roles, false if not

hasPermissions

public AuthService hasPermissions(String loginID,
                                  Set<String> permissions,
                                  Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: AuthService

Does the user have the specified permissions?

Specified by:

hasPermissions in interface AuthService

Parameters:

loginID - the login ID as provided by AuthService.login(io.vertx.core.json.JsonObject, io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>>).

permissions - the set of permissions

resultHandler - will be called with the result - true if has permissions, false if not

setReaperPeriod

public AuthService setReaperPeriod(long reaperPeriod)

Description copied from interface: AuthService

Set the reaper period - how often to check for expired logins, in ms.

Specified by:

setReaperPeriod in interface AuthService

Parameters:

reaperPeriod - the reaper period, in ms

handle

public void handle(Long tid)

Specified by:

handle in interface Handler<Long>

start

public void start()

Description copied from interface: AuthService

Start the service

Specified by:

start in interface AuthService

stop

public void stop()

Description copied from interface: AuthService

Stop the service

Specified by:

stop in interface AuthService