An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows.

no subtypes hierarchy

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

Add a set of required authorities for this auth handler

Parameters:
  • authorities

    the set of authorities

addAuthorityshared actual default AuthHandler addAuthority(String authority)

Add a required authority for this auth handler

Parameters:
  • authority

    the authority

authorizeshared actual default 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.

extraParamsshared default OAuth2AuthHandler extraParams(Object extraParams)

Extra parameters needed to be passed while requesting a token.

Parameters:
  • extraParams

    extra optional parameters.

handleshared actual default void handle(RoutingContext arg0)
parseCredentialsshared actual default 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.

setupCallbackshared default OAuth2AuthHandler setupCallback(Route route)

add the callback handler to a given route.

Parameters:
  • route

    a given route e.g.: /callback

Inherited Methods
Methods inherited from: Object
equals
Methods inherited from: AuthHandler