Class OwnerPermissionReader

Allows control access if the request is being made by an owner of the pod containing the resource.

Hierarchy (view full)

PermissionReader
- OwnerPermissionReader

Index

Constructors

Properties

Methods

canHandle findOwners findPods handle handleSafe

Constructors

constructor

new OwnerPermissionReader(podStore, authStrategy, storageStrategy): OwnerPermissionReader
Parameters
- podStore: PodStore
- authStrategy: AuxiliaryIdentifierStrategy
- storageStrategy: StorageLocationStrategy
Returns OwnerPermissionReader
Overrides PermissionReader.constructor
- Defined in src/authorization/OwnerPermissionReader.ts:23

Properties

`Protected` `Readonly`logger

logger: Logger = ...

Methods

canHandle

canHandle(input): Promise<void>
Checks whether the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: PermissionReaderInput
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from PermissionReader.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:18

`Protected`findOwners

findOwners(pods): Promise<Record<string, string[]>>
Finds the owners of the given pods. Return value is a record where the keys are the pods and the values are all the WebIDs that own this pod.
Parameters
- pods: string[]
Returns Promise<Record<string, string[]>>
- Defined in src/authorization/OwnerPermissionReader.ts:95

`Protected`findPods

findPods(identifiers): Promise<Record<string, string>>
Finds all pods that contain the given identifiers. Return value is a record where the keys are the identifiers and the values the associated pod.
Parameters
- identifiers: ResourceIdentifier[]
Returns Promise<Record<string, string>>
- Defined in src/authorization/OwnerPermissionReader.ts:76

handle

handle(input): Promise<PermissionMap>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.
Parameters
- input: PermissionReaderInput
  Input that needs to be handled.
Returns Promise<PermissionMap>
A promise resolving when handling is finished.
Overrides PermissionReader.handle
- Defined in src/authorization/OwnerPermissionReader.ts:34

handleSafe

handleSafe(input): Promise<PermissionMap>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: PermissionReaderInput
  Input data that will be handled if it can be handled.
Returns Promise<PermissionMap>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from PermissionReader.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41