Class OwnerPermissionReader

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

Hierarchy

PermissionReader
- OwnerPermissionReader

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OwnerPermissionReader(accountStore: AccountStore, aclStrategy: AuxiliaryIdentifierStrategy): OwnerPermissionReader

Overrides PermissionReader.constructor
- Defined in src/authorization/OwnerPermissionReader.ts:21
Parameters
- accountStore: AccountStore
- aclStrategy: AuxiliaryIdentifierStrategy
Returns OwnerPermissionReader

Properties

Private Readonly accountStore

accountStore: AccountStore

Private Readonly aclStrategy

aclStrategy: AuxiliaryIdentifierStrategy

Protected Readonly logger

logger: Logger = ...

Methods

canHandle

canHandle(input: PermissionReaderInput): Promise<void>

Inherited from PermissionReader.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if 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.

Private ensurePodOwner

ensurePodOwner(__namedParameters: PermissionReaderInput): Promise<void>

- Defined in src/authorization/OwnerPermissionReader.ts:49
Verify that all conditions are fulfilled to give the owner access.

Parameters
- __namedParameters: PermissionReaderInput
Returns Promise<void>

handle

handle(input: PermissionReaderInput): Promise<Partial<Record<CredentialGroup, Partial<Record<AccessMode, boolean>>>>>

Overrides PermissionReader.handle
- Defined in src/authorization/OwnerPermissionReader.ts:27
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
Returns Promise<Partial<Record<CredentialGroup, Partial<Record<AccessMode, boolean>>>>>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: PermissionReaderInput): Promise<Partial<Record<CredentialGroup, Partial<Record<AccessMode, boolean>>>>>

Inherited from PermissionReader.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
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<Partial<Record<CredentialGroup, Partial<Record<AccessMode, boolean>>>>>
A promise resolving if the input can be handled, rejecting with an Error if not.