OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationRulesProxyManager
Implementsosid.OsidProxyManager
osid.authorization.rules.AuthorizationRulesProfile
Description

The authorization rules proxy manager provides access to authorization rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

  • AuthorizationEnablerLookupSession: a session to retrieve authorization enablers
  • AuthorizationEnablerQuerySession: a session to query for authorization enablers
  • AuthorizationEnablerSearchSession: a session to search for authorization enablers
  • AuthorizationEnablerAdminSession: a session to create and delete authorization enablers
  • AuthorizationEnablerNotificationSession: a session to receive notifications pertaining to authorization enabler changes
  • AuthorizationEnablerVaultSession: a session to look up authorization enabler vault mappings
  • AuthorizationEnablerVaultAssignmentSession: a session to manage authorization enabler to vault mappings
  • AuthorizationEnablerSmartVaultSession: a session to manage dynamic vaults of authorization enablers
  • AuthorizationEnablerRuleLookupSession: a session to look up authorization enabler to authorization mappings
  • AuthorizationEnablerRuleApplicationSession: a session to assign authorization enablers to authorizations
MethodgetAuthorizationEnablerLookupSession
Description

Gets the OsidSession associated with the authorization enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerLookupSessionan AuthorizationEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerLookup() is true.
MethodgetAuthorizationEnablerLookupSessionForVault
Description

Gets the OsidSession associated with the authorization enabler lookup service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerLookupSessionan AuthorizationEnablerLookupSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerLookup() and supportsVisibleFederation() are true.
MethodgetAuthorizationEnablerQuerySession
Description

Gets the OsidSession associated with the authorization enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerQuerySessionan AuthorizationEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerQuery() is true.
MethodgetAuthorizationEnablerQuerySessionForVault
Description

Gets the OsidSession associated with the authorization enabler query service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerQuerySessionan AuthorizationEnablerQuerySession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerQuery() and supportsVisibleFederation() are true.
MethodgetAuthorizationEnablerSearchSession
Description

Gets the OsidSession associated with the authorization enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerSearchSessionan AuthorizationEnablerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerSearch() is true.
MethodgetAuthorizationEnablerSearchSessionForVault
Description

Gets the OsidSession associated with the authorization enablers earch service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerSearchSessionan AuthorizationEnablerSearchSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerSearch() and supportsVisibleFederation() are true.
MethodgetAuthorizationEnablerAdminSession
Description

Gets the OsidSession associated with the authorization enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerAdminSessionan AuthorizationEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerAdmin() is true.
MethodgetAuthorizationEnablerAdminSessionForVault
Description

Gets the OsidSession associated with the authorization enabler administration service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerAdminSessionan AuthorizationEnablerAdminSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetAuthorizationEnablerNotificationSession
Description

Gets the OsidSession associated with the authorization enabler notification service.

Parametersosid.authorization.rules.AuthorizationEnablerReceiverauthorizationEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerNotificationSessionan AuthorizationEnablerNotificationSession
ErrorsNULL_ARGUMENT authorizationEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerNotification() is true.
MethodgetAuthorizationEnablerNotificationSessionForVault
Description

Gets the OsidSession associated with the authorization enabler notification service for the given vault.

Parametersosid.authorization.rules.AuthorizationEnablerReceiverauthorizationEnablerReceiverthe notification callback
osid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerNotificationSessionan AuthorizationEnablerNotificationSession
ErrorsNOT_FOUNDno vault found by the given Id
NULL_ARGUMENT authorizationEnablerReceiver, vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerNotification() and supportsVisibleFederation() are true.
MethodgetAuthorizationEnablerVaultSession
Description

Gets the OsidSession to lookup authorization enabler/vault mappings for authorization enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerVaultSessionan AuthorizationEnablerVaultSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerVault() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerVault() is true.
MethodgetAuthorizationEnablerVaultAssignmentSession
Description

Gets the OsidSession associated with assigning authorization enablers to vaults for authorization.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerVaultAssignmentSessionan AuthorizationEnablerVaultAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerVaultAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerVaultAssignment() is true.
MethodgetAuthorizationEnablerSmartVaultSession
Description

Gets the OsidSession to manage authorization enabler smart vaults.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerSmartVaultSessionan AuthorizationEnablerSmartVaultSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerSmartVault() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerSmartVault() is true.
MethodgetAuthorizationEnablerRuleLookupSession
Description

Gets the OsidSession associated with the authorization enabler mapping lookup service for looking up the rules applied to the vault.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerRuleLookupSessionan AuthorizationEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerAuthorizationRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerRuleLookup() is true.
MethodgetAuthorizationEnablerRuleLookupSessionForVault
Description

Gets the OsidSession associated with the authorization enabler authorization mapping lookup service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerRuleLookupSessionan AuthorizationEnablerRuleLookupSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetAuthorizationEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the authorization enabler authorization assignment service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerRuleApplicationSessionan AuthorizationEnablernRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerRuleApplication() is true.
MethodgetAuthorizationEnablerRuleApplicationSessionForVault
Description

Gets the OsidSession associated with the authorization enabler authorization assignment service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.rules.AuthorizationEnablerRuleApplicationSessionan AuthorizationEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationEnablerRuleApplication() and supportsVisibleFederation() are true.