io.vertx.ext.auth.shiro.impl

Class ShiroAuthProviderImpl

java.lang.Object

io.vertx.ext.auth.shiro.impl.ShiroAuthProviderImpl

All Implemented Interfaces:

AuthProvider, ShiroAuthProvider

public class ShiroAuthProviderImpl
extends Object
implements ShiroAuthProvider

Shiro API is unfortunately inherently synchronous, so we need to execute everything on the worker pool

Author:

Tim Fox

Constructor Summary

Constructors

Constructor and Description
ShiroAuthProviderImpl(Vertx vertx, ShiroAuthRealm realm)
ShiroAuthProviderImpl(Vertx vertx, ShiroAuthRealmType realmType, JsonObject config)

Method Summary

Modifier and Type	Method and Description
void	hasPermission(JsonObject principal, String permission, Handler<AsyncResult<Boolean>> resultHandler) Handle whether a principal has a permission
void	hasRole(JsonObject principal, String role, Handler<AsyncResult<Boolean>> resultHandler) Handle whether a principal has a role
void	login(JsonObject principal, JsonObject credentials, Handler<AsyncResult<Void>> resultHandler) Handle the actual login

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.shiro.ShiroAuthProvider

create, create

Constructor Detail

ShiroAuthProviderImpl

public ShiroAuthProviderImpl(Vertx vertx,
                             ShiroAuthRealmType realmType,
                             JsonObject config)

ShiroAuthProviderImpl

public ShiroAuthProviderImpl(Vertx vertx,
                             ShiroAuthRealm realm)

Method Detail

login

public void login(JsonObject principal,
                  JsonObject credentials,
                  Handler<AsyncResult<Void>> resultHandler)

Description copied from interface: AuthProvider

Handle the actual login

Specified by:

login in interface AuthProvider

Parameters:

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

credentials - the credentials - this can contain anything your provider expects, e.g. password

resultHandler - - this must return a failed result if login fails and it must return a succeeded result if the login succeeds

hasRole

public void hasRole(JsonObject principal,
                    String role,
                    Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: AuthProvider

Handle whether a principal has a role

Specified by:

hasRole in interface AuthProvider

Parameters:

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

role - the role

resultHandler - this must return a failure if the check could not be performed - e.g. the principal is not known. Otherwise it must return a succeeded result which contains a boolean `true` if the principal has the role, or `false` if they do not have the role.

hasPermission

public void hasPermission(JsonObject principal,
                          String permission,
                          Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: AuthProvider

Handle whether a principal has a permission

Specified by:

hasPermission in interface AuthProvider

Parameters:

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

permission - the permission

resultHandler - this must return a failure if the check could not be performed - e.g. the principal is not known. Otherwise it must return a succeeded result which contains a boolean `true` if the principal has the permission, or `false` if they do not have the permission.