Class IdpRouteController

Handles an IDP interaction route. All routes need to extract interaction details to render the UI and accept a POST request to do some action.

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
Parameters
- input: HttpHandlerInput
Returns Promise<void>

handle

handle(input: InteractionHttpHandlerInput): Promise<void>

Overrides RouterHandler.handle
- Defined in src/identity/interaction/util/IdpRouteController.ts:32
Parameters
- input: InteractionHttpHandlerInput
Returns Promise<void>

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, details: any, errorMessage?: string, prefilled?: {}): Promise<void>

- Defined in src/identity/interaction/util/IdpRouteController.ts:24
Calls the renderHandler to render using the given response and props. details typed as any since the interactionDetails output typings are not exposed.

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