Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OwnershipValidator

A class that validates if a someone owns a WebId. Will throw an error if the WebId is not valid or ownership could not be validated. The error message should contain a description of what is wrong and how it can be resolved.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

canHandle

  • canHandle(input: { webId: string }): Promise<void>

  • Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

    Parameters

    • input: { webId: string }

      Input data that could potentially be handled.

      • webId: string

    Returns Promise<void>

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

Abstract handle

  • handle(input: { webId: string }): Promise<void>

  • Handles the given input. This should only be done if the canHandle function returned true. Therefore, consider using the handleSafe function instead.

    Parameters

    • input: { webId: string }

      Input data that needs to be handled.

      • webId: string

    Returns Promise<void>

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

handleSafe

  • handleSafe(input: { webId: string }): Promise<void>

  • 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: { webId: string }

      Input data that will be handled if it can be handled.

      • webId: string

    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.