Class IdpRouteController

Handles an IDP interaction route. All routes render their UI on a GET and accept POST requests to handle the interaction.

Hierarchy

RouterHandler
- IdpRouteController

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IdpRouteController(pathName: string, renderHandler: IdpRenderHandler, postHandler: HttpHandler): IdpRouteController

Overrides RouterHandler.constructor
- Defined in src/identity/interaction/util/IdpRouteController.ts:13
Parameters
- pathName: string
- renderHandler: IdpRenderHandler
- postHandler: HttpHandler
Returns IdpRouteController

Properties

Protected Readonly allowedMethods

allowedMethods: string[]

Protected Readonly allowedPathNamesRegEx

allowedPathNamesRegEx: RegExp[]

Protected Readonly handler

handler: HttpHandler

Private Readonly renderHandler

renderHandler: IdpRenderHandler

Methods

canHandle

canHandle(input: HttpHandlerInput): Promise<void>

Inherited from RouterHandler.canHandle
- Defined in src/server/util/RouterHandler.ts:23
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: HttpHandlerInput
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(input: InteractionHttpHandlerInput): Promise<void>

Overrides RouterHandler.handle
- Defined in src/identity/interaction/util/IdpRouteController.ts:31
Handles the given input. This should only be done if the canHandle function returned true. Therefore, consider using the handleSafe function instead.

Parameters
- input: InteractionHttpHandlerInput
Returns Promise<void>

A promise resolving when the handling is finished. Return value depends on the given type.

handleSafe

handleSafe(input: HttpHandlerInput): Promise<void>

Inherited from RouterHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:35
Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

Parameters
- input: HttpHandlerInput
  
  Input data that will be handled if it can be handled.
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not. Return value depends on the given type.

Private render

render(input: InteractionHttpHandlerInput, errorMessage?: string, prefilled?: {}): Promise<void>

- Defined in src/identity/interaction/util/IdpRouteController.ts:23
Calls the renderHandler to render using the given response and props.

Parameters
- input: InteractionHttpHandlerInput
- errorMessage: string = ''
- prefilled: {} = {}
Returns Promise<void>