OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerVaultAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign AuthorizationEnabler to Vault mappings. An AuthorizationEnabler may appear in multiple Vault objects and removing the last reference to an AuthorizationEnabler is the equivalent of deleting it. Each Vault may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an AuthorizationEnabler to another Vault is not a copy operation (eg: does not change its Id ).

MethodcanAssignAuthorizationEnablers
Description

Tests if this user can alter authorization enabler/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignAuthorizationEnablersToVault
Description

Tests if this user can alter authorization enabler/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdvaultIdthe Id of the Vault
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT vaultId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableVaultIds
Description

Gets a list of vaults including and under the given vault node in which any authorization enabler can be assigned.

Parametersosid.id.IdvaultIdthe Id of the Vault
Returnosid.id.IdListlist of assignable vault Ids
ErrorsNULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableVaultIdsForAuthorizationEnabler
Description

Gets a list of vaults including and under the given vault node in which a specific authorization enabler can be assigned.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
Returnosid.id.IdListlist of assignable vault Ids
ErrorsNULL_ARGUMENT vaultId or authorizationEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuthorizationEnablerToVault
Description

Adds an existing AuthorizationEnabler to a Vault.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
osid.id.IdvaultIdthe Id of the Vault
ErrorsALREADY_EXISTS authorizationEnablerId already assigned to vaultI
NOT_FOUND authorizationEnablerId or vaultId not found
NULL_ARGUMENT authorizationEnablerId or vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAuthorizationEnablerFromVault
Description

Removes an AuthorizationEnabler from a Vault.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
osid.id.IdvaultIdthe Id of the Vault
ErrorsNOT_FOUND authorizationEnablerId or vaultId not found or authorizationEnablerId not assigned to vaultId
NULL_ARGUMENT authorizationEnablerId or vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuthorizationEnablerToVault
Description

Moves an AuthorizationEnabler from one Vault to another. Mappings to other Vaults are unaffected.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
osid.id.IdfromVaultIdthe Id of the current Vault
osid.id.IdtoVaultIdthe Id of the destination Vault
ErrorsNOT_FOUND authorizationEnablerId, fromVaultId, or toVaultId not found or authorizationEnablerId not mapped to fromVaultId
NULL_ARGUMENT authorizationEnablerId, fromVaultId, or toVaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.