Packages

class ShiroAuth extends AuthProvider

Factory interface for creating Apache Shiro based io.vertx.scala.ext.auth.AuthProvider instances.

Linear Supertypes
AuthProvider, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShiroAuth
  2. AuthProvider
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ShiroAuth(_asJava: AnyRef)

Value Members

  1. def asJava: AnyRef
    Definition Classes
    AuthProvider
  2. def authenticate(authInfo: JsonObject, resultHandler: Handler[AsyncResult[User]]): Unit

    Authenticate a user.

    Authenticate a user.

    The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure: 

      {
    "username": "tim",
    "password": "mypassword"
  `
    For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

    If the user is successfully authenticated a io.vertx.scala.ext.auth.User object is passed to the handler in an io.vertx.scala.core.AsyncResult. The user object can then be used for authorisation. * @param authInfo The auth information

    resultHandler

    The result handler

    Definition Classes
    AuthProvider
  3. def authenticateFuture(authInfo: JsonObject): Future[User]

    Like authenticate but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like authenticate but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
    AuthProvider
  4. def setRolePrefix(rolePrefix: String): ShiroAuth

    Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    Set the role prefix to distinguish from permissions when checking for isPermitted requests. * @param rolePrefix a Prefix e.g.: "role:"

    returns

    a reference to this for fluency