Class AuthenticatedLdpHandler

The central manager that connects all the necessary handlers to go from an incoming request to an executed operation.

Hierarchy

HttpHandler
- AuthenticatedLdpHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AuthenticatedLdpHandler(args: AuthenticatedLdpHandlerArgs): AuthenticatedLdpHandler

Inherited from HttpHandler.constructor
- Defined in src/ldp/AuthenticatedLdpHandler.ts:58
Creates the handler.

Parameters
- args: AuthenticatedLdpHandlerArgs
  
  The handlers required. None of them are optional.
Returns AuthenticatedLdpHandler

Properties

Private Readonly authorizer

authorizer: Authorizer

Private Readonly credentialsExtractor

credentialsExtractor: CredentialsExtractor

Private Readonly logger

logger: Logger = ...

Private Readonly operationHandler

operationHandler: OperationHandler

Private Readonly permissionsExtractor

permissionsExtractor: PermissionsExtractor

Private Readonly requestParser

requestParser: RequestParser

Private Readonly responseWriter

responseWriter: ResponseWriter

Methods

canHandle

canHandle(input: HttpHandlerInput): Promise<void>

Overrides HttpHandler.canHandle
- Defined in src/ldp/AuthenticatedLdpHandler.ts:76
Checks if the incoming request can be handled. The check is very non-restrictive and will usually be true. It is based on whether the incoming request can be parsed to an operation.

Parameters
- input: HttpHandlerInput
  
  Incoming request and response. Only the request will be used.
Returns Promise<void>

A promise resolving if this request can be handled, otherwise rejecting with an Error.

handle

handle(input: HttpHandlerInput): Promise<void>

Overrides HttpHandler.handle
- Defined in src/ldp/AuthenticatedLdpHandler.ts:93
Handles the incoming request and writes out the response. This includes the following steps:
- Parsing the request to an Operation.
- Extracting credentials from the request.
- Extracting the required permissions.
- Validating if this operation is allowed.
- Executing the operation.
- Writing out the response.
Parameters
- input: HttpHandlerInput
  
  The incoming request and response object to write to.
Returns Promise<void>

A promise resolving when the handling is finished.

handleSafe

handleSafe(input: HttpHandlerInput): Promise<void>

Inherited from HttpHandler.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 runHandlers

runHandlers(request: Guarded<IncomingMessage>): Promise<ResponseDescription>

- Defined in src/ldp/AuthenticatedLdpHandler.ts:116
Runs all handlers except writing the output to the response. This because any errors thrown here have an impact on the response.

Parameters
- request: Guarded<IncomingMessage>
  
  Incoming request.
Returns Promise<ResponseDescription>

A promise resolving to the generated Operation.