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 Modifier and Type | Method and 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.
|
QualifierVaultSession |
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.
|
changeBranch, initialize, rollbackService
close
getAuthorizationConditionRecordTypes, getAuthorizationRecordTypes, getAuthorizationSearchRecordTypes, getFunctionRecordTypes, getFunctionSearchRecordTypes, getQualifierRecordTypes, getQualifierSearchRecordTypes, getVaultRecordTypes, getVaultSearchRecordTypes, supportsAuthorizatinBatch, supportsAuthorizatinRules, supportsAuthorization, supportsAuthorizationAdmin, supportsAuthorizationConditionRecordType, supportsAuthorizationLookup, supportsAuthorizationNotification, supportsAuthorizationQuery, supportsAuthorizationRecordType, supportsAuthorizationSearch, supportsAuthorizationSearchRecordType, supportsAuthorizationSmartVault, supportsAuthorizationVault, supportsAuthorizationVaultAssignment, supportsFunctionAdmin, supportsFunctionLookup, supportsFunctionNotification, supportsFunctionQuery, supportsFunctionRecordType, supportsFunctionSearch, supportsFunctionSearchRecordType, supportsFunctionSmartVault, supportsFunctionVault, supportsFunctionVaultAssignment, supportsQualifierAdmin, supportsQualifierHierarchy, supportsQualifierHierarchyDesign, supportsQualifierLookup, supportsQualifierNotification, supportsQualifierQuery, supportsQualifierRecordType, supportsQualifierSearch, supportsQualifierSearchRecordType, supportsQualifierSmartVault, supportsQualifierVault, supportsQualifierVaultAssignment, supportsVaultAdmin, supportsVaultHierarchy, supportsVaultHierarchyDesign, supportsVaultLookup, supportsVaultNotification, supportsVaultQuery, supportsVaultRecordType, supportsVaultSearch, supportsVaultSearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AuthorizationSession getAuthorizationSession() throws OperationFailedException
AuthorizationSession
which is responsible for
performing authorization checks.OperationFailedException
- unable to complete requestUnimplementedException
- supportsAuthorization()
is false
optional
- This method must be implemented if
supportsAuthorization()
is true.
AuthorizationSession getAuthorizationSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
AuthorizationSession
which is responsible for
performing authorization checks for the given vault.vaultId
- the Id
of the vault an AuthorizationSession
NotFoundException
- vaultId
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsAuthorization()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAuthorization()
and
supportsVisibleFederation()
are true.
AuthorizationLookupSession getAuthorizationLookupSession() throws OperationFailedException
OsidSession
associated with the authorization
lookup service. AuthorizationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationLookup()
is false
optional
- This method must be implemented if
supportsAuthorizationLookup()
is true.
AuthorizationLookupSession getAuthorizationLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
lookup service for the given vault.vaultId
- the Id
of the vault an AuthorizationLookupSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAuthorizationLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationLookup()
and
supportsVisibleFederation()
are true.
AuthorizationQuerySession getAuthorizationQuerySession() throws OperationFailedException
OsidSession
associated with the authorization
query service. AuthorizationQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationQuery()
is false
optional
- This method must be implemented if
supportsAuthorizationQuery()
is true.
AuthorizationQuerySession getAuthorizationQuerySessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
query service for the given vault.vaultId
- the Id
of the vault an AuthorizationQuerySession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAuthorizationQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationQuery()
and
supportsVisibleFederation()
are true.
AuthorizationSearchSession getAuthorizationSearchSession() throws OperationFailedException
OsidSession
associated with the authorization
search service. AuthorizationSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationSearch()
is false
optional
- This method must be implemented if
supportsAuthorizationSearch()
is true.
AuthorizationSearchSession getAuthorizationSearchSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
search service for the given vault.vaultId
- the Id
of the vault an AuthorizationSearchSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAuthorizationSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationSearch()
and
supportsVisibleFederation()
are true.
AuthorizationAdminSession getAuthorizationAdminSession() throws OperationFailedException
OsidSession
associated with the authorization
administration service. AuthorizationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationAdmin()
is false
optional
- This method must be implemented if
supportsAuthorizationAdmin()
is true.
AuthorizationAdminSession getAuthorizationAdminSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
admin service for the given vault.vaultId
- the Id
of the vault an AuthorizationAdminSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAuthorizationAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationAdmin()
and
supportsVisibleFederation()
are true.
AuthorizationNotificationSession getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver) throws OperationFailedException
authorizationReceiver
- the authorization receiver AuthorizationNotificationSession
NullArgumentException
- authorizationReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationNotification()
is false
optional
- This method must be implemented if
supportsAuthorizationNotification()
is
true.
AuthorizationNotificationSession getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver, Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
notification service for the given vault.authorizationReceiver
- the authorization receivervaultId
- the Id
of the vault an AuthorizationNotificationSession
NotFoundException
- vaultId
not foundNullArgumentException
- authorizationReceiver
or vaultId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAuthorizationNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationNotification()
and
supportsVisibleFederation()
are true.
AuthorizationVaultSession getAuthorizationVaultSession() throws OperationFailedException
AuthorizationVaultSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationVault()
is false
optional
- This method must be implemented if
supportsAuthorizationVault()
is true.
AuthorizationVaultAssignmentSession getAuthorizationVaultAssignmentSession() throws OperationFailedException
AuthorizationVaultAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationVaultAssignment()
is false
optional
- This method must be implemented if
supportsAuthorizationVaultAssignment()
is
true.
AuthorizationSmartVaultSession getAuthorizationSmartVaultSession(Id vaultId) throws NotFoundException, OperationFailedException
vaultId
- the Id
of the vault AuthorizationSmartVaultSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationSmartVault()
is false
optional
- This method must be implemented if
supportsAuthorizationSmartVault()
is true.
FunctionLookupSession getFunctionLookupSession() throws OperationFailedException
OsidSession
associated with the function
lookup service. FunctionLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionLookup()
is false
optional
- This method must be implemented if
supportsFunctionLookup()
is true.
FunctionLookupSession getFunctionLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the function
lookup service for the given vault.vaultId
- the Id
of the vault a FunctionLookupSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsFunctionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFunctionLookup()
and
supportsVisibleFederation()
are true.
FunctionQuerySession getFunctionQuerySession() throws OperationFailedException
OsidSession
associated with the function query
service. FunctionQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFunctionQuery()
is false
optional
- This method must be implemented if
supportsFunctionQuery()
is true.
FunctionQuerySession getFunctionQuerySessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the function query
service for the given vault.vaultId
- the Id
of the vault FunctionQuerySession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsFunctionQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsFunctionQuery()
and
supportsVisibleFederation()
are true.
FunctionSearchSession getFunctionSearchSession() throws OperationFailedException
OsidSession
associated with the function
search service. FunctionSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionSearch()
is false
optional
- This method must be implemented if
supportsFunctionSearch()
is true.
FunctionSearchSession getFunctionSearchSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the function
search service for the given vault.vaultId
- the Id
of the vault FunctionSearchSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsFunctionSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFunctionSearch()
and
supportsVisibleFederation()
are true.
FunctionAdminSession getFunctionAdminSession() throws OperationFailedException
OsidSession
associated with the function
administration service. FunctionAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFunctionAdmin()
is false
optional
- This method must be implemented if
supportsFunctionAdmin()
is true.
FunctionAdminSession getFunctionAdminSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the function admin
service for the given vault.vaultId
- the Id
of the vault a FunctionAdminSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsFunctionAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsFunctionAdmin()
and
supportsVisibleFederation()
are true.
FunctionNotificationSession getFunctionNotificationSession(FunctionReceiver functionReceiver) throws OperationFailedException
functionReceiver
- the function receiver FunctionNotificationSession
NullArgumentException
- functionReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionNotification()
is false
optional
- This method must be implemented if
supportsFunctionNotification()
is true.
FunctionNotificationSession getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver, Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the function
notification service for the given vault.functionReceiver
- the function receivervaultId
- the Id
of the vault a FunctionNotificationSession
NotFoundException
- vaultId
not foundNullArgumentException
- functionReceiver
or vaultId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsFunctionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsFunctionNotification()
and
supportsVisibleFederation()
are true.
FunctionVaultSession getFunctionVaultSession() throws OperationFailedException
FunctionVaultSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFunctionVault()
is false
optional
- This method must be implemented if
supportsFunctionVault()
is true.
FunctionVaultAssignmentSession getFunctionVaultAssignmentSession() throws OperationFailedException
FunctionVaultAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionVaultAssignment()
is false
optional
- This method must be implemented if
supportsFunctionVaultAssignment()
is true.
FunctionSmartVaultSession getFunctionSmartVaultSession(Id vaultId) throws NotFoundException, OperationFailedException
vaultId
- the Id
of the vault FunctionSmartVaultSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionSmartVault()
is false
optional
- This method must be implemented if
supportsFunctionSmartVault()
is true.
QualifierLookupSession getQualifierLookupSession() throws OperationFailedException
OsidSession
associated with the qualifier
lookup service. QualifierLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierLookup()
is false
optional
- This method must be implemented if
supportsQualifierLookup()
is true.
QualifierLookupSession getQualifierLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
lookup service for the given vault.vaultId
- the Id
of the vault QualifierLookupSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsQualifierLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQualifierLookup()
and
supportsVisibleFederation()
are true.
QualifierQuerySession getQualifierQuerySession() throws OperationFailedException
OsidSession
associated with the qualifier
query service. QualifierQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierQuery()
is false
optional
- This method must be implemented if
supportsQualifierQuery()
is true.
QualifierQuerySession getQualifierQuerySessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
query service for the given vault.vaultId
- the Id
of the vault QualifierQuerySession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsQualifierQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQualifierQuery()
and
supportsVisibleFederation()
are true.
QualifierSearchSession getQualifierSearchSession() throws OperationFailedException
OsidSession
associated with the qualifier
search service. QualifierSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierSearch()
is false
optional
- This method must be implemented if
supportsQualifierSearch()
is true.
QualifierSearchSession getQualifierSearchSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
search service for the given vault.vaultId
- the Id
of the vault QualifierSearchSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsQualifierSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQualifierSearch()
and
supportsVisibleFederation()
are true.
QualifierAdminSession getQualifierAdminSession() throws OperationFailedException
OsidSession
associated with the qualifier
administration service. QualifierAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierAdmin()
is false
optional
- This method must be implemented if
supportsQualifierAdmin()
is true.
QualifierAdminSession getQualifierAdminSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
admin service for the given vault.vaultId
- the Id
of the vault QualifierAdminSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsQualifierAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQualifierAdmin()
and
supportsVisibleFederation()
are true.
QualifierNotificationSession getQualifierNotificationSession(QualifierReceiver qualifierReceiver) throws OperationFailedException
qualifierReceiver
- the qualifier receiver QualifierNotificationSession
NullArgumentException
- qualifierReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierNotification()
is false
optional
- This method must be implemented if
supportsQualifierNotification()
is true.
QualifierNotificationSession getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver, Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
notification service for the given vault.qualifierReceiver
- the qualifier receivervaultId
- the Id
of the vault QualifierNotificationSession
NotFoundException
- vaultId
not foundNullArgumentException
- qualifierReceiver
or vaultId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsQualifierNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQualifierNotification()
and
supportsVisibleFederation()
are true.
QualifierHierarchySession getQualifierHierarchySession(Id qualifierHierarchyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
hierarchy traversal service. The authorization service uses distinct
hierarchies that can be managed through a Hierarchy OSID.qualifierHierarchyId
- the Id
of a qualifier
hierarchy QualifierHierarchySession
NotFoundException
- qualifierHierarchyId
not foundNullArgumentException
- qualifierHierarchyId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierHierarchy()
is false
optional
- This method must be implemented if
supportsQualifierHierarchy()
is true.
QualifierHierarchyDesignSession getQualifierHierarchyDesignSession(Id qualifierHierarchyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
hierarchy design service.qualifierHierarchyId
- the Id
of a qualifier
hierarchy QualifierHierarchyDesignSession
NotFoundException
- qualifierHierarchyId
not foundNullArgumentException
- qualifierHierarchyId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierHierarchyDesign()
is false
optional
- This method must be implemented if
supportsQualifierHierarchyDesign()
is true.
QualifierVaultSession getQualifierVaultSession() throws OperationFailedException
QualifierVaultSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierVault()
is false
optional
- This method must be implemented if
supportsQualifierVault()
is true.
QualifierVaultSession getQualifierVaultAssignmentSession() throws OperationFailedException
QualifierVaultAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierVaultAssignment()
is false
optional
- This method must be implemented if
supportsQualifierVaultAssignment()
is true.
QualifierSmartVaultSession getQualifierSmartVaultSession(Id vaultId) throws NotFoundException, OperationFailedException
vaultId
- the Id
of the vault QualifierSmartVaultSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierSmartVault()
is false
optional
- This method must be implemented if
supportsQualifierSmartVault()
is true.
VaultLookupSession getVaultLookupSession() throws OperationFailedException
VaultLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultLookup()
is false
optional
- This method must be implemented if
supportsVaultLookup()
is true. VaultQuerySession getVaultQuerySession() throws OperationFailedException
VaultQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultQuery() is
false
optional
- This method must be implemented if
supportsVaultQuery()
is true. VaultSearchSession getVaultSearchSession() throws OperationFailedException
VaultSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultSearch()
is false
optional
- This method must be implemented if
supportsVaultSearch()
is true. VaultAdminSession getVaultAdminSession() throws OperationFailedException
VaultAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultAdmin() is
false
optional
- This method must be implemented if
supportsVaultAdmin()
is true. VaultNotificationSession getVaultNotificationSession(VaultReceiver vaultreceiver) throws OperationFailedException
vaultreceiver
- the vault receiver VaultNotificationSession
NullArgumentException
- vaultReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsVaultNotification() is false
optional
- This method must be implemented if
supportsVaultNotification()
is true. VaultHierarchySession getVaultHierarchySession() throws OperationFailedException
VaultHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsVaultHierarchy() is false
optional
- This method must be implemented if
supportsVaultHierarchy()
is true. VaultHierarchyDesignSession getVaultHierarchyDesignSession() throws OperationFailedException
VaultHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsVaultHierarchyDesign() is false
optional
- This method must be implemented if
supportsVaultHierarchyDesign()
is true. AuthorizationBatchManager getAuthorizationBatchManager() throws OperationFailedException
AuthorizationBatchManager.
AuthorizationBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationBatch() is false
optional
- This method must be implemented if
supportsAuthorizationBatch()
is true. AuthorizationRulesManager getAuthorizationRulesManager() throws OperationFailedException
AuthorizationRulesManager.
AuthorizationRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationRules() is false
optional
- This method must be implemented if
supportsAuthorizationRules()
is true.