org.osid.authorization

Interface AuthorizationProxyManager

All Superinterfaces:

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

public interface AuthorizationProxyManager
extends OsidProxyManager, AuthorizationProfile

The authorization manager provides access to authorization sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• AuthorizationSession: a session to performs authorization checks
• AuthorizationLookupSession: a session to look up Authorizations
• AuthorizationSearchSession: a session to search Authorizations
• AuthorizationAdminSession: a session to create, modify and delete Authorizations
• AuthorizationNotificationSession: a session to receive messages pertaining to Authorization changes
• AuthorizationVaultSession: a session to look up authorization to vault mappings
• AuthorizationVaultAssignmentSession: a session to manage authorization to vault mappings
• AuthorizationSmartVaultSession: a session to manage smart authorization vault

• FunctionLookupSession: a session to look up Functions
• FunctionQuerySession: a session to query Functions
• FunctionSearchSession: a session to search Functions
• FunctionAdminSession: a session to create, modify and delete Functions
• FunctionNotificationSession: a session to receive messages pertaining to Function changes
• FunctionVaultSession: a session for looking up function and vault mappings
• FunctionVaultAssignmentSession: a session for managing function and vault mappings
• FunctionSmartVaultSession: a session to manage dynamic function vaults

• QualifierLookupSession: a session to look up Qualifiers
• QualifierQuerySession: a session to query Qualifiers
• QualifierSearchSession: a session to search Qualifiers
• QualifierAdminSession: a session to create, modify and delete Qualifiers
• QualifierNotificationSession: a session to receive messages pertaining to Qualifier changes
• QualifierHierarchySession: a session for traversing qualifier hierarchies
• QualifierHierarchyDesignSession: a session for managing qualifier hierarchies
• QualifierVaultSession: a session for looking up qualifier and vault mappings
• QualifierVaultAssignmentSession: a session for managing qualifier and vault mappings
• QualifierSmartVaultSession: a session to manage dynamic qualifier vaults

• VaultLookupSession: a session to lookup vaults
• VaultQuerySession: a session to query Vaults
• VaultSearchSession : a session to search vaults
• VaultAdminSession : a session to create, modify and delete vaults
• VaultNotificationSession : a session to receive messages pertaining to Vault changes
• VaultHierarchySession : a session to traverse the Vault hierarchy
• VaultHierarchyDesignSession : a session to manage the Vault hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationAdminSession	getAuthorizationAdminSession(Proxy proxy) Gets the OsidSession associated with the authorization administration service.
AuthorizationAdminSession	getAuthorizationAdminSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization admin service for the given vault.
AuthorizationBatchProxyManager	getAuthorizationBatchProxyManager() Gets an AuthorizationBatchProxyManager.
AuthorizationLookupSession	getAuthorizationLookupSession(Proxy proxy) Gets the OsidSession associated with the authorization lookup service.
AuthorizationLookupSession	getAuthorizationLookupSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization lookup service for the given vault.
AuthorizationNotificationSession	getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver, Proxy proxy) Gets the notification session for notifications pertaining to authorization changes.
AuthorizationNotificationSession	getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver, Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization notification service for the given vault.
AuthorizationQuerySession	getAuthorizationQuerySession(Proxy proxy) Gets the OsidSession associated with the authorization query service.
AuthorizationQuerySession	getAuthorizationQuerySessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization query service for the given vault.
AuthorizationRulesProxyManager	getAuthorizationRulesProxyManager() Gets an AuthorizationRulesProxyManager.
AuthorizationSearchSession	getAuthorizationSearchSession(Proxy proxy) Gets the OsidSession associated with the authorization search service.
AuthorizationSearchSession	getAuthorizationSearchSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the authorization search service for the given vault.
AuthorizationSession	getAuthorizationSession(Proxy proxy) Gets an AuthorizationSession which is responsible for performing authorization checks.
AuthorizationSession	getAuthorizationSessionForVault(Id vaultId, Proxy proxy) Gets an AuthorizationSession which is responsible for performing authorization checks for the given vault.
AuthorizationSmartVaultSession	getAuthorizationSmartVaultSession(Id vaultId, Proxy proxy) Gets the session for managing dynamic authorization vault.
AuthorizationVaultAssignmentSession	getAuthorizationVaultAssignmentSession(Proxy proxy) Gets the session for assigning authorization to vault mappings.
AuthorizationVaultSession	getAuthorizationVaultSession(Proxy proxy) Gets the session for retrieving authorization to vault mappings.
FunctionAdminSession	getFunctionAdminSession(Proxy proxy) Gets the OsidSession associated with the function administration service.
FunctionAdminSession	getFunctionAdminSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the function admin service for the given vault.
FunctionLookupSession	getFunctionLookupSession(Proxy proxy) Gets the OsidSession associated with the function lookup service.
FunctionLookupSession	getFunctionLookupSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the function lookup service for the given vault.
FunctionNotificationSession	getFunctionNotificationSession(FunctionReceiver functionReceiver, Proxy proxy) Gets the notification session for notifications pertaining to function changes.
FunctionNotificationSession	getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver, Id vaultId, Proxy proxy) Gets the OsidSession associated with the function notification service for the given vault.
FunctionQuerySession	getFunctionQuerySession(Proxy proxy) Gets the OsidSession associated with the function query service.
FunctionQuerySession	getFunctionQuerySessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the function query service for the given vault.
FunctionSearchSession	getFunctionSearchSession(Proxy proxy) Gets the OsidSession associated with the function search service.
FunctionSearchSession	getFunctionSearchSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the function search service for the given vault.
FunctionSmartVaultSession	getFunctionSmartVaultSession(Id vaultId, Proxy proxy) Gets the session for managing dynamic function vaults for the given vault.
FunctionVaultAssignmentSession	getFunctionVaultAssignmentSession(Proxy proxy) Gets the session for assigning function to vault mappings.
FunctionVaultSession	getFunctionVaultSession(Proxy proxy) Gets the session for retrieving function to vault mappings.
QualifierAdminSession	getQualifierAdminSession(Proxy proxy) Gets the OsidSession associated with the qualifier administration service.
QualifierAdminSession	getQualifierAdminSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the qualifier admin service for the given vault.
QualifierHierarchyDesignSession	getQualifierHierarchyDesignSession(Id qualifierHierarchyId, Proxy proxy) Gets the OsidSession associated with the qualifier hierarchy design service.
QualifierHierarchySession	getQualifierHierarchySession(Id qualifierHierarchyId, Proxy proxy) Gets the OsidSession associated with the qualifier hierarchy traversal service.
QualifierLookupSession	getQualifierLookupSession(Proxy proxy) Gets the OsidSession associated with the qualifier lookup service.
QualifierLookupSession	getQualifierLookupSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the qualifier lookup service for the given vault.
QualifierNotificationSession	getQualifierNotificationSession(QualifierReceiver qualifierReceiver, Proxy proxy) Gets the notification session for notifications pertaining to qualifier changes.
QualifierNotificationSession	getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver, Id vaultId, Proxy proxy) Gets the OsidSession associated with the qualifier notification service for the given vault.
QualifierQuerySession	getQualifierQuerySession(Proxy proxy) Gets the OsidSession associated with the qualifier query service.
QualifierQuerySession	getQualifierQuerySessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the qualifier query service for the given vault.
QualifierSearchSession	getQualifierSearchSession(Proxy proxy) Gets the OsidSession associated with the qualifier search service.
QualifierSearchSession	getQualifierSearchSessionForVault(Id vaultId, Proxy proxy) Gets the OsidSession associated with the qualifier search service for the given vault.
QualifierSmartVaultSession	getQualifierSmartVaultSession(Id vaultId, Proxy proxy) Gets the session for managing dynamic qualifier vaults for the given vault.
QualifierVaultSession	getQualifierVaultAssignmentSession(Proxy proxy) Gets the session for assigning qualifier to vault mappings.
QualifierVaultSession	getQualifierVaultSession(Proxy proxy) Gets the session for retrieving qualifier to vault mappings.
VaultAdminSession	getVaultAdminSession(Proxy proxy) Gets the OsidSession associated with the vault administration service.
VaultHierarchyDesignSession	getVaultHierarchyDesignSession(Proxy proxy) Gets the session designing vault hierarchies.
VaultHierarchySession	getVaultHierarchySession(Proxy proxy) Gets the session traversing vault hierarchies.
VaultLookupSession	getVaultLookupSession(Proxy proxy) Gets the OsidSession associated with the vault lookup service.
VaultNotificationSession	getVaultNotificationSession(VaultReceiver vaultReceiver, Proxy proxy) Gets the notification session for notifications pertaining to vault service changes.
VaultQuerySession	getVaultQuerySession(Proxy proxy) Gets the OsidSession associated with the vault query service.
VaultSearchSession	getVaultSearchSession(Proxy proxy) Gets the OsidSession associated with the vault search service.

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.AuthorizationProfile

getAuthorizationConditionRecordTypes, getAuthorizationRecordTypes, getAuthorizationSearchRecordTypes, getFunctionRecordTypes, getFunctionSearchRecordTypes, getQualifierRecordTypes, getQualifierSearchRecordTypes, getVaultRecordTypes, getVaultSearchRecordTypes, supportsAuthorizatinBatch, supportsAuthorizatinRules, supportsAuthorization, supportsAuthorizationAdmin, supportsAuthorizationConditionRecordType, supportsAuthorizationLookup, supportsAuthorizationNotification, supportsAuthorizationQuery, supportsAuthorizationRecordType, supportsAuthorizationSearch, supportsAuthorizationSearchRecordType, supportsAuthorizationSmartVault, supportsAuthorizationVault, supportsAuthorizationVaultAssignment, supportsFunctionAdmin, supportsFunctionLookup, supportsFunctionNotification, supportsFunctionQuery, supportsFunctionRecordType, supportsFunctionSearch, supportsFunctionSearchRecordType, supportsFunctionSmartVault, supportsFunctionVault, supportsFunctionVaultAssignment, supportsQualifierAdmin, supportsQualifierHierarchy, supportsQualifierHierarchyDesign, supportsQualifierLookup, supportsQualifierNotification, supportsQualifierQuery, supportsQualifierRecordType, supportsQualifierSearch, supportsQualifierSearchRecordType, supportsQualifierSmartVault, supportsQualifierVault, supportsQualifierVaultAssignment, supportsVaultAdmin, supportsVaultHierarchy, supportsVaultHierarchyDesign, supportsVaultLookup, supportsVaultNotification, supportsVaultQuery, supportsVaultRecordType, supportsVaultSearch, supportsVaultSearchRecordType, 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

getAuthorizationSession

AuthorizationSession getAuthorizationSession(Proxy proxy)
                                             throws OperationFailedException

Gets an AuthorizationSession which is responsible for performing authorization checks.

Parameters:

proxy - a proxy

Returns:

an authorization session for this service

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorization() is false

Compliance:

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

getAuthorizationSessionForVault

AuthorizationSession getAuthorizationSessionForVault(Id vaultId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets an AuthorizationSession which is responsible for performing authorization checks for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

an AuthorizationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorization() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationLookupSession

AuthorizationLookupSession getAuthorizationLookupSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the authorization lookup service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationLookup() is false

Compliance:

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

getAuthorizationLookupSessionForVault

AuthorizationLookupSession getAuthorizationLookupSessionForVault(Id vaultId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

an AuthorizationLookupSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationLookup() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationQuerySession

AuthorizationQuerySession getAuthorizationQuerySession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the authorization query service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationQuery() is false

Compliance:

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

getAuthorizationQuerySessionForVault

AuthorizationQuerySession getAuthorizationQuerySessionForVault(Id vaultId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

an AuthorizationQuerySession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationQuery() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationSearchSession

AuthorizationSearchSession getAuthorizationSearchSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the authorization search service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationSearch() is false

Compliance:

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

getAuthorizationSearchSessionForVault

AuthorizationSearchSession getAuthorizationSearchSessionForVault(Id vaultId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the authorization search service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

an AuthorizationSearchSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationSearch() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationAdminSession

AuthorizationAdminSession getAuthorizationAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the authorization administration service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationAdmin() is false

Compliance:

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

getAuthorizationAdminSessionForVault

AuthorizationAdminSession getAuthorizationAdminSessionForVault(Id vaultId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the authorization admin service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

an AuthorizationAdminSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationNotificationSession

AuthorizationNotificationSession getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver,
                                                                   Proxy proxy)
                                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to authorization changes.

Parameters:

authorizationReceiver - the authorization receiver

proxy - a proxy

Returns:

an AuthorizationNotificationSession

Throws:

NullArgumentException - authorizationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationNotification() is false

Compliance:

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

getAuthorizationNotificationSessionForVault

AuthorizationNotificationSession getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver,
                                                                           Id vaultId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

authorizationReceiver - the authorization receiver

vaultId - the Id of the vault

proxy - a proxy

Returns:

an AuthorizationNotificationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - authorizationReceiver or vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationNotification() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationVaultSession

AuthorizationVaultSession getAuthorizationVaultSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session for retrieving authorization to vault mappings.

Parameters:

proxy - a proxy

Returns:

an AuthorizationVaultSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationVault() is false

Compliance:

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

getAuthorizationVaultAssignmentSession

AuthorizationVaultAssignmentSession getAuthorizationVaultAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the session for assigning authorization to vault mappings.

Parameters:

proxy - a proxy

Returns:

a AuthorizationVaultAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationVaultAssignment() is false

Compliance:

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

getAuthorizationSmartVaultSession

AuthorizationSmartVaultSession getAuthorizationSmartVaultSession(Id vaultId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session for managing dynamic authorization vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a AuthorizationSmartVaultSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationSmartVault() is false

Compliance:

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

getFunctionLookupSession

FunctionLookupSession getFunctionLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the function lookup service.

Parameters:

proxy - a proxy

Returns:

a FunctionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionLookup() is false

Compliance:

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

getFunctionLookupSessionForVault

FunctionLookupSession getFunctionLookupSessionForVault(Id vaultId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the function lookup service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a FunctionLookupSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionLookup() or supportsVisibleFederation() is false

Compliance:

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

getFunctionQuerySession

FunctionQuerySession getFunctionQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the function query service.

Parameters:

proxy - a proxy

Returns:

a FunctionQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionQuery() is false

Compliance:

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

getFunctionQuerySessionForVault

FunctionQuerySession getFunctionQuerySessionForVault(Id vaultId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the function query service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a FunctionQuerySession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionQuery() or supportsVisibleFederation() is false

Compliance:

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

getFunctionSearchSession

FunctionSearchSession getFunctionSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the function search service.

Parameters:

proxy - a proxy

Returns:

a FunctionSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionSearch() is false

Compliance:

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

getFunctionSearchSessionForVault

FunctionSearchSession getFunctionSearchSessionForVault(Id vaultId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the function search service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a FunctionSearchSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionSearch() or supportsVisibleFederation() is false

Compliance:

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

getFunctionAdminSession

FunctionAdminSession getFunctionAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the function administration service.

Parameters:

proxy - a proxy

Returns:

a FunctionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionAdmin() is false

Compliance:

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

getFunctionAdminSessionForVault

FunctionAdminSession getFunctionAdminSessionForVault(Id vaultId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the function admin service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a FunctionAdminSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionAdmin() or supportsVisibleFederation() is false

Compliance:

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

getFunctionNotificationSession

FunctionNotificationSession getFunctionNotificationSession(FunctionReceiver functionReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the notification session for notifications pertaining to function changes.

Parameters:

functionReceiver - the function receiver

proxy - a proxy

Returns:

a FunctionNotificationSession

Throws:

NullArgumentException - functionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionNotification() is false

Compliance:

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

getFunctionNotificationSessionForVault

FunctionNotificationSession getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver,
                                                                 Id vaultId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the function notification service for the given vault.

Parameters:

functionReceiver - the function receiver

vaultId - the Id of the vault

proxy - a proxy

Returns:

a FunctionNotificationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - functionReceiver or vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionNotification() or supportsVisibleFederation() is false

Compliance:

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

getFunctionVaultSession

FunctionVaultSession getFunctionVaultSession(Proxy proxy)
                                             throws OperationFailedException

Gets the session for retrieving function to vault mappings.

Parameters:

proxy - a proxy

Returns:

a FunctionVaultSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionVault() is false

Compliance:

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

getFunctionVaultAssignmentSession

FunctionVaultAssignmentSession getFunctionVaultAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session for assigning function to vault mappings.

Parameters:

proxy - a proxy

Returns:

a FunctionVaultAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionVaultAssignment() is false

Compliance:

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

getFunctionSmartVaultSession

FunctionSmartVaultSession getFunctionSmartVaultSession(Id vaultId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic function vaults for the given vault.

Parameters:

vaultId - the Id of a vault

proxy - a proxy

Returns:

vaultId not found

Throws:

NotFoundException - vaultId or proxy is null

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionSmartVault() is false

Compliance:

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

getQualifierLookupSession

QualifierLookupSession getQualifierLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the qualifier lookup service.

Parameters:

proxy - a proxy

Returns:

a QualifierLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierLookup() is false

Compliance:

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

getQualifierLookupSessionForVault

QualifierLookupSession getQualifierLookupSessionForVault(Id vaultId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the qualifier lookup service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a QualifierLookupSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierLookup() or supportsVisibleFederation() is false

Compliance:

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

getQualifierQuerySession

QualifierQuerySession getQualifierQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the qualifier query service.

Parameters:

proxy - a proxy

Returns:

a QualifierQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierQuery() is false

Compliance:

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

getQualifierQuerySessionForVault

QualifierQuerySession getQualifierQuerySessionForVault(Id vaultId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the qualifier query service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a QualifierQuerySession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierQuery() or supportsVisibleFederation() is false

Compliance:

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

getQualifierSearchSession

QualifierSearchSession getQualifierSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the qualifier search service.

Parameters:

proxy - a proxy

Returns:

a QualifierSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierSearch() is false

Compliance:

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

getQualifierSearchSessionForVault

QualifierSearchSession getQualifierSearchSessionForVault(Id vaultId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the qualifier search service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a QualifierSearchSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierSearch() or supportsVisibleFederation() is false

Compliance:

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

getQualifierAdminSession

QualifierAdminSession getQualifierAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the qualifier administration service.

Parameters:

proxy - a proxy

Returns:

a QualifierAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierAdmin() is false

Compliance:

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

getQualifierAdminSessionForVault

QualifierAdminSession getQualifierAdminSessionForVault(Id vaultId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the qualifier admin service for the given vault.

Parameters:

vaultId - the Id of the vault

proxy - a proxy

Returns:

a QualifierAdminSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierAdmin() or supportsVisibleFederation() is false

Compliance:

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

getQualifierNotificationSession

QualifierNotificationSession getQualifierNotificationSession(QualifierReceiver qualifierReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the notification session for notifications pertaining to qualifier changes.

Parameters:

qualifierReceiver - the qualifier receiver

proxy - a proxy

Returns:

a QualifierNotificationSession

Throws:

NullArgumentException - qualifierReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierNotification() is false

Compliance:

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

getQualifierNotificationSessionForVault

QualifierNotificationSession getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver,
                                                                   Id vaultId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession associated with the qualifier notification service for the given vault.

Parameters:

qualifierReceiver - the qualifier receiver

vaultId - the Id of the vault

proxy - a proxy

Returns:

a QualifierNotificationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - qualifierReceiver or vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierNotification() or supportsVisibleFederation() is false

Compliance:

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

getQualifierHierarchySession

QualifierHierarchySession getQualifierHierarchySession(Id qualifierHierarchyId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the qualifier hierarchy traversal service. The authorization service uses distinct hierarchies that can be managed through a Hierarchy OSID.

Parameters:

qualifierHierarchyId - the Id of a qualifier hierarchy

proxy - a proxy

Returns:

a QualifierHierarchySession

Throws:

NotFoundException - qualifierHierarchyId not found

NullArgumentException - qualifierHierarchyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierHierarchy() is false

Compliance:

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

getQualifierHierarchyDesignSession

QualifierHierarchyDesignSession getQualifierHierarchyDesignSession(Id qualifierHierarchyId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the qualifier hierarchy design service.

Parameters:

qualifierHierarchyId - the Id of a qualifier hierarchy

proxy - a proxy

Returns:

a QualifierHierarchyDesignSession

Throws:

NotFoundException - qualifierHierarchyId not found

NullArgumentException - qualifierHierarchyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierHierarchyDesign() is false

Compliance:

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

getQualifierVaultSession

QualifierVaultSession getQualifierVaultSession(Proxy proxy)
                                               throws OperationFailedException

Gets the session for retrieving qualifier to vault mappings.

Parameters:

proxy - a proxy

Returns:

a QualifierVaultSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierVault() is false

Compliance:

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

getQualifierVaultAssignmentSession

QualifierVaultSession getQualifierVaultAssignmentSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the session for assigning qualifier to vault mappings.

Parameters:

proxy - a proxy

Returns:

a QualifierVaultAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierVaultAssignment() is false

Compliance:

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

getQualifierSmartVaultSession

QualifierSmartVaultSession getQualifierSmartVaultSession(Id vaultId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the session for managing dynamic qualifier vaults for the given vault.

Parameters:

vaultId - the Id of a vault

proxy - a proxy

Returns:

vaultId not found

Throws:

NotFoundException - vaultId or proxy is null

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierSmartVault() is false

Compliance:

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

getVaultLookupSession

VaultLookupSession getVaultLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the vault lookup service.

Parameters:

proxy - a proxy

Returns:

a VaultLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultLookup() is false

Compliance:

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

getVaultQuerySession

VaultQuerySession getVaultQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the vault query service.

Parameters:

proxy - a proxy

Returns:

a VaultQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultQuery() is false

Compliance:

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

getVaultSearchSession

VaultSearchSession getVaultSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the vault search service.

Parameters:

proxy - a proxy

Returns:

a VaultSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultSearch() is false

Compliance:

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

getVaultAdminSession

VaultAdminSession getVaultAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the vault administration service.

Parameters:

proxy - a proxy

Returns:

a VaultAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultAdmin() is false

Compliance:

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

getVaultNotificationSession

VaultNotificationSession getVaultNotificationSession(VaultReceiver vaultReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to vault service changes.

Parameters:

vaultReceiver - the vault receiver

proxy - a proxy

Returns:

a VaultNotificationSession

Throws:

NullArgumentException - vaultReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultNotification() is false

Compliance:

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

getVaultHierarchySession

VaultHierarchySession getVaultHierarchySession(Proxy proxy)
                                               throws OperationFailedException

Gets the session traversing vault hierarchies.

Parameters:

proxy - a proxy

Returns:

a VaultHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultHierarchy() is false

Compliance:

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

getVaultHierarchyDesignSession

VaultHierarchyDesignSession getVaultHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session designing vault hierarchies.

Parameters:

proxy - a proxy

Returns:

a VaultHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultHierarchyDesign() is false

Compliance:

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

getAuthorizationBatchProxyManager

AuthorizationBatchProxyManager getAuthorizationBatchProxyManager()
                                                                 throws OperationFailedException

Gets an AuthorizationBatchProxyManager.

Returns:

an AuthorizationBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationBatch() is false

Compliance:

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

getAuthorizationRulesProxyManager

AuthorizationRulesProxyManager getAuthorizationRulesProxyManager()
                                                                 throws OperationFailedException

Gets an AuthorizationRulesProxyManager.

Returns:

an AuthorizationRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationRules() is false

Compliance:

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