Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AclManager

Handles where acl resources are stored.

Hierarchy

  • AclManager

Index

Properties

Properties

getAclConstrainedResource

getAclConstrainedResource: (id: ResourceIdentifier) => Promise<ResourceIdentifier>

Returns the identifier of the resource on which the acl constraints are placed. In general, this is the resource identifier when the input is a normal resource, or the non-acl version if the input is an acl resource. This does not guarantee that this resource exists.

param

Identifier of the acl resource.

returns

The ResourceIdentifier of the corresponding resource.

Type declaration

getAclDocument

getAclDocument: (id: ResourceIdentifier) => Promise<ResourceIdentifier>

Returns the identifier of the acl resource corresponding to the given resource. This does not guarantee that this acl resource exists. In the case the input is already an acl resource that will also be the response.

param

The ResourceIdentifier of which we need the corresponding acl resource.

returns

The ResourceIdentifier of the corresponding acl resource.

Type declaration

isAclDocument

isAclDocument: (id: ResourceIdentifier) => Promise<boolean>

Checks if the input identifier corresponds to an acl resource. This does not check if that acl resource exists, only if the identifier indicates that there could be an acl resource there.

param

Identifier to check.

returns

true if the input identifier points to an acl resource.

Type declaration