org.osid.authorization.rules

Interface AuthorizationRulesProxyManager

All Superinterfaces:

AuthorizationRulesProfile, java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface AuthorizationRulesProxyManager
extends OsidProxyManager, AuthorizationRulesProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationEnablerAdminSession	getAuthorizationEnablerAdminSession(Proxy proxy) Gets the OsidSession associated with the authorization enabler administration service.
AuthorizationEnablerAdminSession	getAuthorizationEnablerAdminSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enabler administration service for the given vault.
AuthorizationEnablerLookupSession	getAuthorizationEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the authorization enabler lookup service.
AuthorizationEnablerLookupSession	getAuthorizationEnablerLookupSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enabler lookup service for the given vault.
AuthorizationEnablerNotificationSession	getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the authorization enabler notification service.
AuthorizationEnablerNotificationSession	getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver, Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enabler notification service for the given vault.
AuthorizationEnablerQuerySession	getAuthorizationEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the authorization enabler query service.
AuthorizationEnablerQuerySession	getAuthorizationEnablerQuerySessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enabler query service for the given vault.
AuthorizationEnablerRuleApplicationSession	getAuthorizationEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the authorization enabler authorization assignment service.
AuthorizationEnablerRuleApplicationSession	getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enabler authorization assignment service for the given vault.
AuthorizationEnablerRuleLookupSession	getAuthorizationEnablerRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the authorization enabler mapping lookup service for looking up the rules applied to the vault.
AuthorizationEnablerRuleLookupSession	getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enabler authorization mapping lookup service for the given vault.
AuthorizationEnablerSearchSession	getAuthorizationEnablerSearchSession(Proxy proxy) Gets the OsidSession associated with the authorization enabler search service.
AuthorizationEnablerSearchSession	getAuthorizationEnablerSearchSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization enablers earch service for the given vault.
AuthorizationEnablerSmartVaultSession	getAuthorizationEnablerSmartVaultSession(Id vaultId, Proxy proxy) Gets the OsidSession to manage authorization enabler smart vaults.
AuthorizationEnablerVaultAssignmentSession	getAuthorizationEnablerVaultAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning authorization enablers to vaults for authorization.
AuthorizationEnablerVaultSession	getAuthorizationEnablerVaultSession(Proxy proxy) Gets the OsidSession to lookup authorization enabler/vault mappings for authorization enablers.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.authorization.rules.AuthorizationRulesProfile

getAuthorizationEnablerRecordTypes, getAuthorizationEnablerSearchRecordTypes, supportsAuthorizationEnablerAdmin, supportsAuthorizationEnablerLookup, supportsAuthorizationEnablerNotification, supportsAuthorizationEnablerQuery, supportsAuthorizationEnablerRecordType, supportsAuthorizationEnablerRuleApplication, supportsAuthorizationEnablerRuleLookup, supportsAuthorizationEnablerSearch, supportsAuthorizationEnablerSearchRecordType, supportsAuthorizationEnablerSmartVault, supportsAuthorizationEnablerVault, supportsAuthorizationEnablerVaultAssignment, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAuthorizationEnablerLookupSession

AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the authorization enabler lookup service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerLookup() is true.

getAuthorizationEnablerLookupSessionForVault

AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSessionForVault(Id vaultId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerLookupSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerLookup() and supportsVisibleFederation() are true.

getAuthorizationEnablerQuerySession

AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the authorization enabler query service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerQuery() is true.

getAuthorizationEnablerQuerySessionForVault

AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySessionForVault(Id vaultId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerQuerySession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerQuery() and supportsVisibleFederation() are true.

getAuthorizationEnablerSearchSession

AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the authorization enabler search service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerSearch() is true.

getAuthorizationEnablerSearchSessionForVault

AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSessionForVault(Id vaultId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerSearchSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerSearch() and supportsVisibleFederation() are true.

getAuthorizationEnablerAdminSession

AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the authorization enabler administration service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerAdmin() is true.

getAuthorizationEnablerAdminSessionForVault

AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSessionForVault(Id vaultId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerAdminSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerAdmin() and supportsVisibleFederation() are true.

getAuthorizationEnablerNotificationSession

AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver,
                                                                                 Proxy proxy)
                                                                                   throws OperationFailedException

Gets the OsidSession associated with the authorization enabler notification service.

Parameters:

authorizationEnablerReceiver - the notification callback

proxy - a proxy

Returns:

an AuthorizationEnablerNotificationSession

Throws:

NullArgumentException - authorizationEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerNotification() is true.

getAuthorizationEnablerNotificationSessionForVault

AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver,
                                                                                         Id vaultId,
                                                                                         Proxy proxy)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

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

Parameters:

authorizationEnablerReceiver - the notification callback

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerNotificationSession

Throws:

NotFoundException - no vault found by the given Id

NullArgumentException - authorizationEnablerReceiver, vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerNotification() and supportsVisibleFederation() are true.

getAuthorizationEnablerVaultSession

AuthorizationEnablerVaultSession getAuthorizationEnablerVaultSession(Proxy proxy)
                                                                     throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerVaultSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerVault() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerVault() is true.

getAuthorizationEnablerVaultAssignmentSession

AuthorizationEnablerVaultAssignmentSession getAuthorizationEnablerVaultAssignmentSession(Proxy proxy)
                                                                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerVaultAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerVaultAssignment() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerVaultAssignment() is true.

getAuthorizationEnablerSmartVaultSession

AuthorizationEnablerSmartVaultSession getAuthorizationEnablerSmartVaultSession(Id vaultId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession to manage authorization enabler smart vaults.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerSmartVaultSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerSmartVault() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerSmartVault() is true.

getAuthorizationEnablerRuleLookupSession

AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSession(Proxy proxy)
                                                                               throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerAuthorizationRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerRuleLookup() is true.

getAuthorizationEnablerRuleLookupSessionForVault

AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId,
                                                                                     Proxy proxy)
                                                                                       throws NotFoundException,
                                                                                              OperationFailedException

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

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerRuleLookupSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerRuleLookup() and supportsVisibleFederation() are true.

getAuthorizationEnablerRuleApplicationSession

AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSession(Proxy proxy)
                                                                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablernRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerRuleApplication() is true.

getAuthorizationEnablerRuleApplicationSessionForVault

AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId,
                                                                                               Proxy proxy)
                                                                                                 throws NotFoundException,
                                                                                                        OperationFailedException

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

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerRuleApplicationSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationEnablerRuleApplication() and supportsVisibleFederation() are true.