Interface AuthorizationProxyManager
- All Superinterfaces:
AuthorizationProfile, AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
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 upAuthorizations -
AuthorizationSearchSession:a session to searchAuthorizations -
AuthorizationAdminSession: a session to create, modify and deleteAuthorizations -
AuthorizationNotificationSession: asession to receive messages pertaining toAuthorizationchanges -
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 upFunctions -
FunctionQuerySession: a session to queryFunctions -
FunctionSearchSession:a session to searchFunctions -
FunctionAdminSession: a session to create, modify and deleteFunctions -
FunctionNotificationSession: asession to receive messages pertaining toFunctionchanges -
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 upQualifiers -
QualifierQuerySession: a session to queryQualifiers -
QualifierSearchSession:a session to searchQualifiers -
QualifierAdminSession: a session to create, modify and deleteQualifiers -
QualifierNotificationSession: asession to receive messages pertaining toQualifierchanges -
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 toVaultchanges -
VaultHierarchySession: a session to traverse theVaulthierarchy -
VaultHierarchyDesignSession: a session to manage theVaulthierarchy
-
Method Summary
Modifier and TypeMethodDescriptionGets theOsidSessionassociated with the authorization administration service.getAuthorizationAdminSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the authorization admin service for the given vault.Gets anAuthorizationBatchProxyManager.Gets theOsidSessionassociated with the authorization lookup service.getAuthorizationLookupSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the authorization lookup service for the given vault.getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver, Proxy proxy) Gets the notification session for notifications pertaining to authorization changes.getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver, Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the authorization notification service for the given vault.Gets theOsidSessionassociated with the authorization query service.getAuthorizationQuerySessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the authorization query service for the given vault.Gets anAuthorizationRulesProxyManager.Gets theOsidSessionassociated with the authorization search service.getAuthorizationSearchSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the authorization search service for the given vault.getAuthorizationSession(Proxy proxy) Gets anAuthorizationSessionwhich is responsible for performing authorization checks.getAuthorizationSessionForVault(Id vaultId, Proxy proxy) Gets anAuthorizationSessionwhich is responsible for performing authorization checks for the given vault.getAuthorizationSmartVaultSession(Id vaultId, Proxy proxy) Gets the session for managing dynamic authorization vault.Gets the session for assigning authorization to vault mappings.Gets the session for retrieving authorization to vault mappings.getFunctionAdminSession(Proxy proxy) Gets theOsidSessionassociated with the function administration service.getFunctionAdminSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the function admin service for the given vault.getFunctionLookupSession(Proxy proxy) Gets theOsidSessionassociated with the function lookup service.getFunctionLookupSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the function lookup service for the given vault.getFunctionNotificationSession(FunctionReceiver functionReceiver, Proxy proxy) Gets the notification session for notifications pertaining to function changes.getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver, Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the function notification service for the given vault.getFunctionQuerySession(Proxy proxy) Gets theOsidSessionassociated with the function query service.getFunctionQuerySessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the function query service for the given vault.getFunctionSearchSession(Proxy proxy) Gets theOsidSessionassociated with the function search service.getFunctionSearchSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the function search service for the given vault.getFunctionSmartVaultSession(Id vaultId, Proxy proxy) Gets the session for managing dynamic function vaults for the given vault.Gets the session for assigning function to vault mappings.getFunctionVaultSession(Proxy proxy) Gets the session for retrieving function to vault mappings.getQualifierAdminSession(Proxy proxy) Gets theOsidSessionassociated with the qualifier administration service.getQualifierAdminSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the qualifier admin service for the given vault.getQualifierHierarchyDesignSession(Id qualifierHierarchyId, Proxy proxy) Gets theOsidSessionassociated with the qualifier hierarchy design service.getQualifierHierarchySession(Id qualifierHierarchyId, Proxy proxy) Gets theOsidSessionassociated with the qualifier hierarchy traversal service.getQualifierLookupSession(Proxy proxy) Gets theOsidSessionassociated with the qualifier lookup service.getQualifierLookupSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the qualifier lookup service for the given vault.getQualifierNotificationSession(QualifierReceiver qualifierReceiver, Proxy proxy) Gets the notification session for notifications pertaining to qualifier changes.getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver, Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the qualifier notification service for the given vault.getQualifierQuerySession(Proxy proxy) Gets theOsidSessionassociated with the qualifier query service.getQualifierQuerySessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the qualifier query service for the given vault.getQualifierSearchSession(Proxy proxy) Gets theOsidSessionassociated with the qualifier search service.getQualifierSearchSessionForVault(Id vaultId, Proxy proxy) Gets theOsidSessionassociated with the qualifier search service for the given vault.getQualifierSmartVaultSession(Id vaultId, Proxy proxy) Gets the session for managing dynamic qualifier vaults for the given vault.Gets the session for assigning qualifier to vault mappings.getQualifierVaultSession(Proxy proxy) Gets the session for retrieving qualifier to vault mappings.getVaultAdminSession(Proxy proxy) Gets the OsidSession associated with the vault administration service.Gets the session designing vault hierarchies.getVaultHierarchySession(Proxy proxy) Gets the session traversing vault hierarchies.getVaultLookupSession(Proxy proxy) Gets the OsidSession associated with the vault lookup service.getVaultNotificationSession(VaultReceiver vaultReceiver, Proxy proxy) Gets the notification session for notifications pertaining to vault service changes.getVaultQuerySession(Proxy proxy) Gets the OsidSession associated with the vault query service.getVaultSearchSession(Proxy proxy) 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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedAuthorizationConditionrecord types.Gets the supportedAuthorizationrecord types.Gets the supportedAuthorizationsearch record types.Gets the supportedFunctionrecord types.Gets the supportedFunctionsearch record types.Gets the supportedQualifierrecord types.Gets the supportedQualifiersearch record types.Gets the supportedVaultrecord types.Gets the supported vault search record types.booleanTests for the availability of an authorization service which is the basic service for checking authorizations.booleanTests if an authorization administrative service is supported.booleanTests if an authorization batch service is supported.booleansupportsAuthorizationConditionRecordType(Type authorizationConditionRecordType) Tests if the givenAuthorizationConditionrecord type is supported.booleanTests if an authorization lookup service is supported.booleanTests if authorization notification is supported.booleanTests if an authorization query service is supported.booleansupportsAuthorizationRecordType(Type authorizationRecordType) Tests if the given authorization record type is supported.booleanTests if an authorization rules service is supported.booleanTests if an authorization search service is supported.booleansupportsAuthorizationSearchRecordType(Type authorizationSearchRecordType) Tests if the given authorization search record type is supported.booleanTests if an authorization smart vaulting session is available.booleanTests if an authorization to vault lookup session is available.booleanTests if an authorization to vault assignment session is available.booleanTests if a function administrative service is supported.booleanTests if a function lookup service is supported.booleanTests if function notification is supported.booleanTests if a function query service is supported.booleansupportsFunctionRecordType(Type functionRecordType) Tests if the givenFunctionrecord type is supported.booleanTests if a function search service is supported.booleansupportsFunctionSearchRecordType(Type functionSearchRecordType) Tests if the givenFunctionsearch record type is supported.booleanTests if a function smart vaulting session is available.booleanTests if a function to vault lookup session is available.booleanTests if a function to vault assignment session is available.booleanTests if a qualifier administrative service is supported.booleanTests if a qualifier hierarchy traversal is supported.booleanTests if qualifier hierarchy design is supported.booleanTests if a qualifier lookup service is supported.booleanTests if qualifier notification is supported.booleanTests if a qualifier query service is supported.booleansupportsQualifierRecordType(Type qualifierRecordType) Tests if the givenQualifierrecord type is supported.booleanTests if a qualifier search service is supported.booleansupportsQualifierSearchRecordType(Type qualifierSearchRecordType) Tests if the givenQualifiersearch record type is supported.booleanTests if a qualifier smart vaulting session is available.booleanTests if a qualifier to vault lookup session is available.booleanTests if a qualifier to vault assignment session is available.booleanTests if a vault administrative service is supported.booleanTests if a vault hierarchy traversal is supported.booleanTests if vault hierarchy design is supported.booleanTests if a vault lookup service is supported.booleanTests if vault notification is supported.booleanTests if a vault query service is supported.booleansupportsVaultRecordType(Type vaultRecordType) Tests if the givenVaultrecord type is supported.booleanTests if a vault search service is supported.booleansupportsVaultSearchRecordType(Type vaultSearchRecordType) Tests if the given vault search record type is supported.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getAuthorizationSession
Gets anAuthorizationSessionwhich is responsible for performing authorization checks.- Parameters:
proxy- a proxy- Returns:
- an authorization session for this service
- Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorization()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorization()} is {@code true} .
-
getAuthorizationSessionForVault
AuthorizationSession getAuthorizationSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets anAuthorizationSessionwhich is responsible for performing authorization checks for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
an AuthorizationSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAuthorization()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorization()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAuthorizationLookupSession
AuthorizationLookupSession getAuthorizationLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the authorization lookup service.- Parameters:
proxy- a proxy- Returns:
- an
AuthorizationLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationLookup()} is {@code true} .
-
getAuthorizationLookupSessionForVault
AuthorizationLookupSession getAuthorizationLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the authorization lookup service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
an AuthorizationLookupSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAuthorizationLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAuthorizationQuerySession
Gets theOsidSessionassociated with the authorization query service.- Parameters:
proxy- a proxy- Returns:
- an
AuthorizationQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationQuery()} is {@code true} .
-
getAuthorizationQuerySessionForVault
AuthorizationQuerySession getAuthorizationQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the authorization query service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
an AuthorizationQuerySession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAuthorizationQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAuthorizationSearchSession
AuthorizationSearchSession getAuthorizationSearchSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the authorization search service.- Parameters:
proxy- a proxy- Returns:
- an
AuthorizationSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationSearch()} is {@code true} .
-
getAuthorizationSearchSessionForVault
AuthorizationSearchSession getAuthorizationSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the authorization search service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
an AuthorizationSearchSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAuthorizationSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAuthorizationAdminSession
Gets theOsidSessionassociated with the authorization administration service.- Parameters:
proxy- a proxy- Returns:
- an
AuthorizationAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationAdmin()} is {@code true} .
-
getAuthorizationAdminSessionForVault
AuthorizationAdminSession getAuthorizationAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the authorization admin service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
an AuthorizationAdminSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAuthorizationAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAuthorizationNotificationSession
AuthorizationNotificationSession getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver, Proxy proxy) throws OperationFailedException Gets the notification session for notifications pertaining to authorization changes.- Parameters:
authorizationReceiver- the authorization receiverproxy- a proxy- Returns:
- an
AuthorizationNotificationSession - Throws:
NullArgumentException-authorizationReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationNotification()} is {@code true} .
-
getAuthorizationNotificationSessionForVault
AuthorizationNotificationSession getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver, Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the authorization notification service for the given vault.- Parameters:
authorizationReceiver- the authorization receivervaultId- theIdof the vaultproxy- a proxy- Returns:
- an
AuthorizationNotificationSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-authorizationReceiverorvaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAuthorizationNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAuthorizationVaultSession
Gets the session for retrieving authorization to vault mappings.- Parameters:
proxy- a proxy- Returns:
- an
AuthorizationVaultSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationVault()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationVault()} is {@code 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-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationVaultAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationVaultAssignment()} is {@code true} .
-
getAuthorizationSmartVaultSession
AuthorizationSmartVaultSession getAuthorizationSmartVaultSession(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets the session for managing dynamic authorization vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
AuthorizationSmartVaultSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationSmartVault()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationSmartVault()} is {@code true} .
-
getFunctionLookupSession
Gets theOsidSessionassociated with the function lookup service.- Parameters:
proxy- a proxy- Returns:
- a
FunctionLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionLookup()} is {@code true} .
-
getFunctionLookupSessionForVault
FunctionLookupSession getFunctionLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the function lookup service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
a FunctionLookupSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsFunctionLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getFunctionQuerySession
Gets theOsidSessionassociated with the function query service.- Parameters:
proxy- a proxy- Returns:
- a
FunctionQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionQuery()} is {@code true} .
-
getFunctionQuerySessionForVault
FunctionQuerySession getFunctionQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the function query service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
FunctionQuerySession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsFunctionQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getFunctionSearchSession
Gets theOsidSessionassociated with the function search service.- Parameters:
proxy- a proxy- Returns:
- a
FunctionSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionSearch()} is {@code true} .
-
getFunctionSearchSessionForVault
FunctionSearchSession getFunctionSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the function search service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
FunctionSearchSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsFunctionSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getFunctionAdminSession
Gets theOsidSessionassociated with the function administration service.- Parameters:
proxy- a proxy- Returns:
- a
FunctionAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionAdmin()} is {@code true} .
-
getFunctionAdminSessionForVault
FunctionAdminSession getFunctionAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the function admin service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
a FunctionAdminSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsFunctionAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getFunctionNotificationSession
FunctionNotificationSession getFunctionNotificationSession(FunctionReceiver functionReceiver, Proxy proxy) throws OperationFailedException Gets the notification session for notifications pertaining to function changes.- Parameters:
functionReceiver- the function receiverproxy- a proxy- Returns:
- a
FunctionNotificationSession - Throws:
NullArgumentException-functionReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionNotification()} is {@code true} .
-
getFunctionNotificationSessionForVault
FunctionNotificationSession getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver, Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the function notification service for the given vault.- Parameters:
functionReceiver- the function receivervaultId- theIdof the vaultproxy- a proxy- Returns:
a FunctionNotificationSession- Throws:
NotFoundException-vaultIdnot foundNullArgumentException-functionReceiverorvaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsFunctionNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getFunctionVaultSession
Gets the session for retrieving function to vault mappings.- Parameters:
proxy- a proxy- Returns:
- a
FunctionVaultSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionVault()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionVault()} is {@code 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-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionVaultAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionVaultAssignment()} is {@code 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- theIdof a vaultproxy- a proxy- Returns:
vaultIdnot found- Throws:
NotFoundException-vaultIdorproxyisnullNullArgumentException-vaultIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFunctionSmartVault()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFunctionSmartVault()} is {@code true} .
-
getQualifierLookupSession
Gets theOsidSessionassociated with the qualifier lookup service.- Parameters:
proxy- a proxy- Returns:
- a
QualifierLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierLookup()} is {@code true} .
-
getQualifierLookupSessionForVault
QualifierLookupSession getQualifierLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier lookup service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
QualifierLookupSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsQualifierLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getQualifierQuerySession
Gets theOsidSessionassociated with the qualifier query service.- Parameters:
proxy- a proxy- Returns:
- a
QualifierQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierSearch()} is {@code true} .
-
getQualifierQuerySessionForVault
QualifierQuerySession getQualifierQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier query service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
QualifierQuerySession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsQualifierQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getQualifierSearchSession
Gets theOsidSessionassociated with the qualifier search service.- Parameters:
proxy- a proxy- Returns:
- a
QualifierSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierSearch()} is {@code true} .
-
getQualifierSearchSessionForVault
QualifierSearchSession getQualifierSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier search service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
QualifierSearchSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsQualifierSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getQualifierAdminSession
Gets theOsidSessionassociated with the qualifier administration service.- Parameters:
proxy- a proxy- Returns:
- a
QualifierAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierAdmin()} is {@code true} .
-
getQualifierAdminSessionForVault
QualifierAdminSession getQualifierAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier admin service for the given vault.- Parameters:
vaultId- theIdof the vaultproxy- a proxy- Returns:
- a
QualifierAdminSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-vaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsQualifierAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getQualifierNotificationSession
QualifierNotificationSession getQualifierNotificationSession(QualifierReceiver qualifierReceiver, Proxy proxy) throws OperationFailedException Gets the notification session for notifications pertaining to qualifier changes.- Parameters:
qualifierReceiver- the qualifier receiverproxy- a proxy- Returns:
- a
QualifierNotificationSession - Throws:
NullArgumentException-qualifierReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierNotification()} is {@code true} .
-
getQualifierNotificationSessionForVault
QualifierNotificationSession getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver, Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier notification service for the given vault.- Parameters:
qualifierReceiver- the qualifier receivervaultId- theIdof the vaultproxy- a proxy- Returns:
- a
QualifierNotificationSession - Throws:
NotFoundException-vaultIdnot foundNullArgumentException-qualifierReceiverorvaultIdorproxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsQualifierNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getQualifierHierarchySession
QualifierHierarchySession getQualifierHierarchySession(Id qualifierHierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier hierarchy traversal service. The authorization service uses distinct hierarchies that can be managed through a Hierarchy OSID.- Parameters:
qualifierHierarchyId- theIdof a qualifier hierarchyproxy- a proxy- Returns:
- a
QualifierHierarchySession - Throws:
NotFoundException-qualifierHierarchyIdnot foundNullArgumentException-qualifierHierarchyIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierHierarchy()} is {@code true} .
-
getQualifierHierarchyDesignSession
QualifierHierarchyDesignSession getQualifierHierarchyDesignSession(Id qualifierHierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the qualifier hierarchy design service.- Parameters:
qualifierHierarchyId- theIdof a qualifier hierarchyproxy- a proxy- Returns:
- a
QualifierHierarchyDesignSession - Throws:
NotFoundException-qualifierHierarchyIdnot foundNullArgumentException-qualifierHierarchyIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierHierarchyDesign()} is {@code true} .
-
getQualifierVaultSession
Gets the session for retrieving qualifier to vault mappings.- Parameters:
proxy- a proxy- Returns:
- a
QualifierVaultSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierVault()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierVault()} is {@code true} .
-
getQualifierVaultAssignmentSession
QualifierVaultAssignmentSession getQualifierVaultAssignmentSession(Proxy proxy) throws OperationFailedException Gets the session for assigning qualifier to vault mappings.- Parameters:
proxy- a proxy- Returns:
- a
QualifierVaultAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierVaultAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierVaultAssignment()} is {@code 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- theIdof a vaultproxy- a proxy- Returns:
vaultIdnot found- Throws:
NotFoundException-vaultIdorproxyisnullNullArgumentException-vaultIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQualifierSmartVault()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQualifierSmartVault()} is {@code true} .
-
getVaultLookupSession
Gets the OsidSession associated with the vault lookup service.- Parameters:
proxy- a proxy- Returns:
- a
VaultLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultLookup() is false- Compliance:
optional- This method must be implemented if {@code supportsVaultLookup()} is true.
-
getVaultQuerySession
Gets the OsidSession associated with the vault query service.- Parameters:
proxy- a proxy- Returns:
- a
VaultQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultQuery() is false- Compliance:
optional- This method must be implemented if {@code supportsVaultQuery()} is true.
-
getVaultSearchSession
Gets the OsidSession associated with the vault search service.- Parameters:
proxy- a proxy- Returns:
- a
VaultSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultSearch() is false- Compliance:
optional- This method must be implemented if {@code supportsVaultSearch()} is true.
-
getVaultAdminSession
Gets the OsidSession associated with the vault administration service.- Parameters:
proxy- a proxy- Returns:
- a
VaultAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultAdmin() is false- Compliance:
optional- This method must be implemented if {@code 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 receiverproxy- a proxy- Returns:
- a
VaultNotificationSession - Throws:
NullArgumentException-vaultReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultNotification() is false- Compliance:
optional- This method must be implemented if {@code supportsVaultNotification()} is true.
-
getVaultHierarchySession
Gets the session traversing vault hierarchies.- Parameters:
proxy- a proxy- Returns:
- a
VaultHierarchySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultHierarchy() is false- Compliance:
optional- This method must be implemented if {@code 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-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsVaultHierarchyDesign() is false- Compliance:
optional- This method must be implemented if {@code supportsVaultHierarchyDesign()} is true.
-
getAuthorizationBatchProxyManager
Gets anAuthorizationBatchProxyManager.- Returns:
- an
AuthorizationBatchProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationBatch() is false- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationBatch()} is true.
-
getAuthorizationRulesProxyManager
Gets anAuthorizationRulesProxyManager.- Returns:
- an
AuthorizationRulesProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAuthorizationRules() is false- Compliance:
optional- This method must be implemented if {@code supportsAuthorizationRules()} is true.
-