Base interface for auth handlers.

An auth handler allows your application to provide authentication/authorisation support.

Auth handler requires a SessionHandler to be on the routing chain before it.

no type hierarchy

no supertypes hierarchy

Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
addAuthoritiesshared AuthHandler addAuthorities(Set<String> authorities)

Add a set of required authorities for this auth handler

Parameters:
  • authorities

    the set of authorities

addAuthorityshared AuthHandler addAuthority(String authority)

Add a required authority for this auth handler

Parameters:
  • authority

    the authority

authorizeshared void authorize(User user, Anything(Throwable?) handler)

Authorizes the given user against all added authorities.

Parameters:
  • user

    a user.

  • handler

    the handler for the result.

handleshared void handle(RoutingContext arg0)
parseCredentialsshared void parseCredentials(RoutingContext context, Anything(Throwable|Object) handler)

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

Parameters:
  • context

    the routing context

  • handler

    the handler to be called once the information is available.

Inherited Methods
Methods inherited from: Object
equals