Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SimpleAuthenticationHandler

A user customizable authentication handler.

An auth handler allows your application to provide authentication support. The handler is not fully functional without a authentication function. This function takes the as input and returns a .

The future should return a non null user object. In the {@link SimpleAuthenticationHandler#authenticate} you have full control on the request, so all operations like redirect, next, fail are allowed. There are some rules that need to be followed in order to allow this handler to properly interop with ChainAuthHandler.

Hierarchy

  • SimpleAuthenticationHandler

Implements

Index

Methods

authenticate

  • This function will allow you to perform authentication the way you intended to. The process should be self explanatory, for example if the request contains a given property completing the function with a non null object is enough to allow the handler to continue.

    In order to signal errors, you should not call or .

    Errors should be signaled using the {@link HttpException} type. Any other kind of errors will be wrapped as a 401 error. For example forbidden access should be signaled with: new HttpException(403). This is required when working with ChainAuthHandler. By using exceptions to signal failures instead of immediately terminating the request, it allows the chain to proceed to the next handler if needed.

    Parameters

    Returns SimpleAuthenticationHandler

handle

Static create

  • Creates a new instance of the simple authentication handler.

    Returns SimpleAuthenticationHandler

Generated using TypeDoc