Interface AuthorizationManager

All Superinterfaces:

AuthorizationProfile, AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface AuthorizationManager
extends OsidManager, AuthorizationProfile

The authorization manager provides access to authorization sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• AuthorizationSession : a session to performs authorization checks
• AuthorizationLookupSession : a session to look up Authorizations
• AuthorizationQuerySession : a session to query 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 vaults

• 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

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

Methods inherited from interface AuthorizationProfile

getAuthorizationConditionRecordTypes, getAuthorizationRecordTypes, getAuthorizationSearchRecordTypes, getFunctionRecordTypes, getFunctionSearchRecordTypes, getQualifierRecordTypes, getQualifierSearchRecordTypes, getVaultRecordTypes, getVaultSearchRecordTypes, supportsAuthorization, supportsAuthorizationAdmin, supportsAuthorizationBatch, supportsAuthorizationConditionRecordType, supportsAuthorizationLookup, supportsAuthorizationNotification, supportsAuthorizationQuery, supportsAuthorizationRecordType, supportsAuthorizationRules, 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

Modifier and Type	Method	Description
TypeList	getAuthorizationConditionRecordTypes()	Gets the supported AuthorizationCondition record types.
TypeList	getAuthorizationRecordTypes()	Gets the supported Authorization record types.
TypeList	getAuthorizationSearchRecordTypes()	Gets the supported Authorization search record types.
TypeList	getFunctionRecordTypes()	Gets the supported Function record types.
TypeList	getFunctionSearchRecordTypes()	Gets the supported Function search record types.
TypeList	getQualifierRecordTypes()	Gets the supported Qualifier record types.
TypeList	getQualifierSearchRecordTypes()	Gets the supported Qualifier search record types.
TypeList	getVaultRecordTypes()	Gets the supported Vault record types.
TypeList	getVaultSearchRecordTypes()	Gets the supported vault search record types.
boolean	supportsAuthorization()	Tests for the availability of an authorization service which is the basic service for checking authorizations.
boolean	supportsAuthorizationAdmin()	Tests if an authorization administrative service is supported.
boolean	supportsAuthorizationBatch()	Tests if an authorization batch service is supported.
boolean	supportsAuthorizationConditionRecordType(Type authorizationConditionRecordType)	Tests if the given AuthorizationCondition record type is supported.
boolean	supportsAuthorizationLookup()	Tests if an authorization lookup service is supported.
boolean	supportsAuthorizationNotification()	Tests if authorization notification is supported.
boolean	supportsAuthorizationQuery()	Tests if an authorization query service is supported.
boolean	supportsAuthorizationRecordType(Type authorizationRecordType)	Tests if the given authorization record type is supported.
boolean	supportsAuthorizationRules()	Tests if an authorization rules service is supported.
boolean	supportsAuthorizationSearch()	Tests if an authorization search service is supported.
boolean	supportsAuthorizationSearchRecordType(Type authorizationSearchRecordType)	Tests if the given authorization search record type is supported.
boolean	supportsAuthorizationSmartVault()	Tests if an authorization smart vaulting session is available.
boolean	supportsAuthorizationVault()	Tests if an authorization to vault lookup session is available.
boolean	supportsAuthorizationVaultAssignment()	Tests if an authorization to vault assignment session is available.
boolean	supportsFunctionAdmin()	Tests if a function administrative service is supported.
boolean	supportsFunctionLookup()	Tests if a function lookup service is supported.
boolean	supportsFunctionNotification()	Tests if function notification is supported.
boolean	supportsFunctionQuery()	Tests if a function query service is supported.
boolean	supportsFunctionRecordType(Type functionRecordType)	Tests if the given Function record type is supported.
boolean	supportsFunctionSearch()	Tests if a function search service is supported.
boolean	supportsFunctionSearchRecordType(Type functionSearchRecordType)	Tests if the given Function search record type is supported.
boolean	supportsFunctionSmartVault()	Tests if a function smart vaulting session is available.
boolean	supportsFunctionVault()	Tests if a function to vault lookup session is available.
boolean	supportsFunctionVaultAssignment()	Tests if a function to vault assignment session is available.
boolean	supportsQualifierAdmin()	Tests if a qualifier administrative service is supported.
boolean	supportsQualifierHierarchy()	Tests if a qualifier hierarchy traversal is supported.
boolean	supportsQualifierHierarchyDesign()	Tests if qualifier hierarchy design is supported.
boolean	supportsQualifierLookup()	Tests if a qualifier lookup service is supported.
boolean	supportsQualifierNotification()	Tests if qualifier notification is supported.
boolean	supportsQualifierQuery()	Tests if a qualifier query service is supported.
boolean	supportsQualifierRecordType(Type qualifierRecordType)	Tests if the given Qualifier record type is supported.
boolean	supportsQualifierSearch()	Tests if a qualifier search service is supported.
boolean	supportsQualifierSearchRecordType(Type qualifierSearchRecordType)	Tests if the given Qualifier search record type is supported.
boolean	supportsQualifierSmartVault()	Tests if a qualifier smart vaulting session is available.
boolean	supportsQualifierVault()	Tests if a qualifier to vault lookup session is available.
boolean	supportsQualifierVaultAssignment()	Tests if a qualifier to vault assignment session is available.
boolean	supportsVaultAdmin()	Tests if a vault administrative service is supported.
boolean	supportsVaultHierarchy()	Tests if a vault hierarchy traversal is supported.
boolean	supportsVaultHierarchyDesign()	Tests if vault hierarchy design is supported.
boolean	supportsVaultLookup()	Tests if a vault lookup service is supported.
boolean	supportsVaultNotification()	Tests if vault notification is supported.
boolean	supportsVaultQuery()	Tests if a vault query service is supported.
boolean	supportsVaultRecordType(Type vaultRecordType)	Tests if the given Vault record type is supported.
boolean	supportsVaultSearch()	Tests if a vault search service is supported.
boolean	supportsVaultSearchRecordType(Type vaultSearchRecordType)	Tests if the given vault search record type is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getAuthorizationSession

AuthorizationSession getAuthorizationSession()
                                      throws OperationFailedException

Gets an AuthorizationSession which is responsible for performing authorization checks.

Returns:

an authorization session for this service

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorization() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorization()} is {@code true} .

getAuthorizationSessionForVault

AuthorizationSession getAuthorizationSessionForVault(Id vaultId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

an AuthorizationSession

Throws:

NotFoundException - vaultId

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorization() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationLookupSession

AuthorizationLookupSession getAuthorizationLookupSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the authorization lookup service.

Returns:

an AuthorizationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationLookup()} is {@code true} .

getAuthorizationLookupSessionForVault

AuthorizationLookupSession getAuthorizationLookupSessionForVault(Id vaultId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

an AuthorizationLookupSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationLookup() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationQuerySession

AuthorizationQuerySession getAuthorizationQuerySession()
                                                throws OperationFailedException

Gets the OsidSession associated with the authorization query service.

Returns:

an AuthorizationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationQuery()} is {@code true} .

getAuthorizationQuerySessionForVault

AuthorizationQuerySession getAuthorizationQuerySessionForVault(Id vaultId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

an AuthorizationQuerySession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationQuery() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationSearchSession

AuthorizationSearchSession getAuthorizationSearchSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the authorization search service.

Returns:

an AuthorizationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationSearch()} is {@code true} .

getAuthorizationSearchSessionForVault

AuthorizationSearchSession getAuthorizationSearchSessionForVault(Id vaultId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

an AuthorizationSearchSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationSearch() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationAdminSession

AuthorizationAdminSession getAuthorizationAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the authorization administration service.

Returns:

an AuthorizationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationAdmin()} is {@code true} .

getAuthorizationAdminSessionForVault

AuthorizationAdminSession getAuthorizationAdminSessionForVault(Id vaultId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

an AuthorizationAdminSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationNotificationSession

AuthorizationNotificationSession getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver)
                                                              throws OperationFailedException

Gets the notification session for notifications pertaining to authorization changes.

Parameters:

authorizationReceiver - the authorization receiver

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 {@code supportsAuthorizationNotification()} is {@code true} .

getAuthorizationNotificationSessionForVault

AuthorizationNotificationSession getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver,
 Id vaultId)
                                                                      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

Returns:

an AuthorizationNotificationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - authorizationReceiver or vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationNotification() or supportsVisibleFederation() is false

Compliance:

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

getAuthorizationVaultSession

AuthorizationVaultSession getAuthorizationVaultSession()
                                                throws OperationFailedException

Gets the session for retrieving authorization to vault mappings.

Returns:

an AuthorizationVaultSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationVault() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationVault()} is {@code true} .

getAuthorizationVaultAssignmentSession

AuthorizationVaultAssignmentSession getAuthorizationVaultAssignmentSession()
                                                                    throws OperationFailedException

Gets the session for assigning authorizations to vault mappings.

Returns:

a AuthorizationVaultAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationVaultAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationVaultAssignment()} is {@code true} .

getAuthorizationSmartVaultSession

AuthorizationSmartVaultSession getAuthorizationSmartVaultSession(Id vaultId)
                                                          throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic authorization vaults.

Parameters:

vaultId - the Id of the vault

Returns:

a AuthorizationSmartVaultSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationSmartVault() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationSmartVault()} is {@code true} .

getFunctionLookupSession

FunctionLookupSession getFunctionLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the function lookup service.

Returns:

a FunctionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionLookup()} is {@code true} .

getFunctionLookupSessionForVault

FunctionLookupSession getFunctionLookupSessionForVault(Id vaultId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a FunctionLookupSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionLookup() or supportsVisibleFederation() is false

Compliance:

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

getFunctionQuerySession

FunctionQuerySession getFunctionQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the function query service.

Returns:

a FunctionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionQuery()} is {@code true} .

getFunctionQuerySessionForVault

FunctionQuerySession getFunctionQuerySessionForVault(Id vaultId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a FunctionQuerySession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionQuery() or supportsVisibleFederation() is false

Compliance:

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

getFunctionSearchSession

FunctionSearchSession getFunctionSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the function search service.

Returns:

a FunctionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionSearch()} is {@code true} .

getFunctionSearchSessionForVault

FunctionSearchSession getFunctionSearchSessionForVault(Id vaultId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a FunctionSearchSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionSearch() or supportsVisibleFederation() is false

Compliance:

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

getFunctionAdminSession

FunctionAdminSession getFunctionAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the function administration service.

Returns:

a FunctionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionAdmin()} is {@code true} .

getFunctionAdminSessionForVault

FunctionAdminSession getFunctionAdminSessionForVault(Id vaultId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a FunctionAdminSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionAdmin() or supportsVisibleFederation() is false

Compliance:

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

getFunctionNotificationSession

FunctionNotificationSession getFunctionNotificationSession(FunctionReceiver functionReceiver)
                                                    throws OperationFailedException

Gets the notification session for notifications pertaining to function changes.

Parameters:

functionReceiver - the function receiver

Returns:

a FunctionNotificationSession

Throws:

NullArgumentException - functionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionNotification()} is {@code true} .

getFunctionNotificationSessionForVault

FunctionNotificationSession getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver,
 Id vaultId)
                                                            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

Returns:

a FunctionNotificationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - functionReceiver or vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionNotification() or supportsVisibleFederation() is false

Compliance:

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

getFunctionVaultSession

FunctionVaultSession getFunctionVaultSession()
                                      throws OperationFailedException

Gets the session for retrieving function to vault mappings.

Returns:

a FunctionVaultSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionVault() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionVault()} is {@code true} .

getFunctionVaultAssignmentSession

FunctionVaultAssignmentSession getFunctionVaultAssignmentSession()
                                                          throws OperationFailedException

Gets the session for assigning function to vault mappings.

Returns:

a FunctionVaultAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionVaultAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionVaultAssignment()} is {@code true} .

getFunctionSmartVaultSession

FunctionSmartVaultSession getFunctionSmartVaultSession(Id vaultId)
                                                throws NotFoundException,
OperationFailedException

Gets the session associated with the function smart vault for the given vault.

Parameters:

vaultId - the Id of the vault

Returns:

a FunctionSmartVaultSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFunctionSmartVault() is false

Compliance:

optional - This method must be implemented if {@code supportsFunctionSmartVault()} is {@code true} .

getQualifierLookupSession

QualifierLookupSession getQualifierLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the qualifier lookup service.

Returns:

a QualifierLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierLookup()} is {@code true} .

getQualifierLookupSessionForVault

QualifierLookupSession getQualifierLookupSessionForVault(Id vaultId)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a QualifierLookupSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierLookup() or supportsVisibleFederation() is false

Compliance:

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

getQualifierQuerySession

QualifierQuerySession getQualifierQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the qualifier query service.

Returns:

a QualifierQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierQuery()} is {@code true} .

getQualifierQuerySessionForVault

QualifierQuerySession getQualifierQuerySessionForVault(Id vaultId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a QualifierQuerySession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierQuery() or supportsVisibleFederation() is false

Compliance:

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

getQualifierSearchSession

QualifierSearchSession getQualifierSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the qualifier search service.

Returns:

a QualifierSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierSearch()} is {@code true} .

getQualifierSearchSessionForVault

QualifierSearchSession getQualifierSearchSessionForVault(Id vaultId)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a QualifierSearchSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierSearch() or supportsVisibleFederation() is false

Compliance:

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

getQualifierAdminSession

QualifierAdminSession getQualifierAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the qualifier administration service.

Returns:

a QualifierAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierAdmin()} is {@code true} .

getQualifierAdminSessionForVault

QualifierAdminSession getQualifierAdminSessionForVault(Id vaultId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

vaultId - the Id of the vault

Returns:

a QualifierAdminSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierAdmin() or supportsVisibleFederation() is false

Compliance:

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

getQualifierNotificationSession

QualifierNotificationSession getQualifierNotificationSession(QualifierReceiver qualifierReceiver)
                                                      throws OperationFailedException

Gets the notification session for notifications pertaining to qualifier changes.

Parameters:

qualifierReceiver - the qualifier receiver

Returns:

a QualifierNotificationSession

Throws:

NullArgumentException - qualifierReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierNotification()} is {@code true} .

getQualifierNotificationSessionForVault

QualifierNotificationSession getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver,
 Id vaultId)
                                                              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

Returns:

a QualifierNotificationSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - qualifierReceiver or vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierNotification() or supportsVisibleFederation() is false

Compliance:

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

getQualifierHierarchySession

QualifierHierarchySession getQualifierHierarchySession(Id qualifierHierarchyId)
                                                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

Returns:

a QualifierHierarchySession

Throws:

NotFoundException - qualifierHierarchyId not found

NullArgumentException - qualifierHierarchyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierHierarchy()} is {@code true} .

getQualifierHierarchyDesignSession

QualifierHierarchyDesignSession getQualifierHierarchyDesignSession(Id qualifierHierarchyId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the qualifier hierarchy design service.

Parameters:

qualifierHierarchyId - the Id of a qualifier hierarchy

Returns:

a QualifierHierarchyDesignSession

Throws:

NotFoundException - qualifierHierarchyId not found

NullArgumentException - qualifierHierarchyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierHierarchyDesign()} is {@code true} .

getQualifierVaultSession

QualifierVaultSession getQualifierVaultSession()
                                        throws OperationFailedException

Gets the session for retrieving qualifier to vault mappings.

Returns:

a QualifierVaultSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierVault() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierVault()} is {@code true} .

getQualifierVaultAssignmentSession

QualifierVaultAssignmentSession getQualifierVaultAssignmentSession()
                                                            throws OperationFailedException

Gets the session for assigning qualifier to vault mappings.

Returns:

a QualifierVaultAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierVaultAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierVaultAssignment()} is {@code true} .

getQualifierSmartVaultSession

QualifierSmartVaultSession getQualifierSmartVaultSession(Id vaultId)
                                                  throws NotFoundException,
OperationFailedException

Gets the session associated with the qualifier smart vault for the given vault.

Parameters:

vaultId - the Id of the vault

Returns:

a QualifierSmartVaultSession

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQualifierSmartVault() is false

Compliance:

optional - This method must be implemented if {@code supportsQualifierSmartVault()} is {@code true} .

getVaultLookupSession

VaultLookupSession getVaultLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the vault lookup service.

Returns:

a VaultLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultLookup()} is true.

getVaultQuerySession

VaultQuerySession getVaultQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the vault query service.

Returns:

a VaultQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultQuery()} is true.

getVaultSearchSession

VaultSearchSession getVaultSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the vault search service.

Returns:

a VaultSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultSearch()} is true.

getVaultAdminSession

VaultAdminSession getVaultAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the vault administration service.

Returns:

a VaultAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultAdmin()} is true.

getVaultNotificationSession

VaultNotificationSession getVaultNotificationSession(VaultReceiver vaultReceiver)
                                              throws OperationFailedException

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

Parameters:

vaultReceiver - the vault receiver

Returns:

a VaultNotificationSession

Throws:

NullArgumentException - vaultReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultNotification()} is true.

getVaultHierarchySession

VaultHierarchySession getVaultHierarchySession()
                                        throws OperationFailedException

Gets the session traversing vault hierarchies.

Returns:

a VaultHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultHierarchy()} is true.

getVaultHierarchyDesignSession

VaultHierarchyDesignSession getVaultHierarchyDesignSession()
                                                    throws OperationFailedException

Gets the session designing vault hierarchies.

Returns:

a VaultHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsVaultHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsVaultHierarchyDesign()} is true.

getAuthorizationBatchManager

AuthorizationBatchManager getAuthorizationBatchManager()
                                                throws OperationFailedException

Gets an AuthorizationBatchManager .

Returns:

an AuthorizationBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationBatch()} is true.

getAuthorizationRulesManager

AuthorizationRulesManager getAuthorizationRulesManager()
                                                throws OperationFailedException

Gets an AuthorizationRulesManager .

Returns:

an AuthorizationRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationRules() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationRules()} is true.