public interface AuthorizationProxyManager extends OsidProxyManager, AuthorizationProfile
The authorization manager provides access to authorization sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager support the passing of a Proxy
object. The sessions included in this manager are:
AuthorizationSession:
a session to performs
authorization checks AuthorizationLookupSession:
a session to look up
Authorizations
AuthorizationSearchSession:
a session to search
Authorizations
AuthorizationAdminSession:
a session to create,
modify and delete Authorizations
AuthorizationNotificationSession: a
session to
receive messages pertaining to Authorization
changes
AuthorizationVaultSession:
a session to look up
authorization to vault mappings AuthorizationVaultAssignmentSession:
a session to
manage authorization to vault mappings AuthorizationSmartVaultSession:
a session to
manage smart authorization vault FunctionLookupSession:
a session to look up
Functions
FunctionQuerySession:
a session to query
Functions
FunctionSearchSession:
a session to search
Functions
FunctionAdminSession:
a session to create, modify
and delete Functions
FunctionNotificationSession: a
session to receive
messages pertaining to Function
changes FunctionVaultSession:
a session for looking up
function and vault mappings FunctionVaultAssignmentSession:
a session for
managing function and vault mappings FunctionSmartVaultSession:
a session to manage
dynamic function vaults QualifierLookupSession:
a session to look up
Qualifiers
QualifierQuerySession:
a session to query
Qualifiers
QualifierSearchSession:
a session to search
Qualifiers
QualifierAdminSession:
a session to create, modify
and delete Qualifiers
QualifierNotificationSession: a
session to receive
messages pertaining to Qualifier
changes QualifierHierarchySession:
a session for
traversing qualifier hierarchies QualifierHierarchyDesignSession:
a session for
managing qualifier hierarchies QualifierVaultSession:
a session for looking up
qualifier and vault mappings QualifierVaultAssignmentSession:
a session for
managing qualifier and vault mappings QualifierSmartVaultSession:
a session to manage
dynamic qualifier vaults VaultLookupSession:
a session to lookup vaults
VaultQuerySession:
a session to query Vaults VaultSearchSession
: a session to search vaults
VaultAdminSession
: a session to create, modify
and delete vaults VaultNotificationSession
: a session to receive
messages pertaining to Vault
changes VaultHierarchySession
: a session to traverse the
Vault
hierarchy VaultHierarchyDesignSession
: a session to manage
the Vault
hierarchy Modifier and Type | Method and Description |
---|---|
AuthorizationAdminSession |
getAuthorizationAdminSession(Proxy proxy)
Gets the
OsidSession associated with the authorization
administration service. |
AuthorizationAdminSession |
getAuthorizationAdminSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the authorization
admin service for the given vault. |
AuthorizationBatchProxyManager |
getAuthorizationBatchProxyManager()
Gets an
AuthorizationBatchProxyManager. |
AuthorizationLookupSession |
getAuthorizationLookupSession(Proxy proxy)
Gets the
OsidSession associated with the authorization
lookup service. |
AuthorizationLookupSession |
getAuthorizationLookupSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the authorization
lookup service for the given vault. |
AuthorizationNotificationSession |
getAuthorizationNotificationSession(AuthorizationReceiver authorizationReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to
authorization changes.
|
AuthorizationNotificationSession |
getAuthorizationNotificationSessionForVault(AuthorizationReceiver authorizationReceiver,
Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the authorization
notification service for the given vault. |
AuthorizationQuerySession |
getAuthorizationQuerySession(Proxy proxy)
Gets the
OsidSession associated with the authorization
query service. |
AuthorizationQuerySession |
getAuthorizationQuerySessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the authorization
query service for the given vault. |
AuthorizationRulesProxyManager |
getAuthorizationRulesProxyManager()
Gets an
AuthorizationRulesProxyManager. |
AuthorizationSearchSession |
getAuthorizationSearchSession(Proxy proxy)
Gets the
OsidSession associated with the authorization
search service. |
AuthorizationSearchSession |
getAuthorizationSearchSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the authorization
search service for the given vault. |
AuthorizationSession |
getAuthorizationSession(Proxy proxy)
Gets an
AuthorizationSession which is responsible for
performing authorization checks. |
AuthorizationSession |
getAuthorizationSessionForVault(Id vaultId,
Proxy proxy)
Gets an
AuthorizationSession which is responsible for
performing authorization checks for the given vault. |
AuthorizationSmartVaultSession |
getAuthorizationSmartVaultSession(Id vaultId,
Proxy proxy)
Gets the session for managing dynamic authorization vault.
|
AuthorizationVaultAssignmentSession |
getAuthorizationVaultAssignmentSession(Proxy proxy)
Gets the session for assigning authorization to vault mappings.
|
AuthorizationVaultSession |
getAuthorizationVaultSession(Proxy proxy)
Gets the session for retrieving authorization to vault mappings.
|
FunctionAdminSession |
getFunctionAdminSession(Proxy proxy)
Gets the
OsidSession associated with the function
administration service. |
FunctionAdminSession |
getFunctionAdminSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the function admin
service for the given vault. |
FunctionLookupSession |
getFunctionLookupSession(Proxy proxy)
Gets the
OsidSession associated with the function
lookup service. |
FunctionLookupSession |
getFunctionLookupSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the function
lookup service for the given vault. |
FunctionNotificationSession |
getFunctionNotificationSession(FunctionReceiver functionReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to function
changes.
|
FunctionNotificationSession |
getFunctionNotificationSessionForVault(FunctionReceiver functionReceiver,
Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the function
notification service for the given vault. |
FunctionQuerySession |
getFunctionQuerySession(Proxy proxy)
Gets the
OsidSession associated with the function query
service. |
FunctionQuerySession |
getFunctionQuerySessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the function query
service for the given vault. |
FunctionSearchSession |
getFunctionSearchSession(Proxy proxy)
Gets the
OsidSession associated with the function
search service. |
FunctionSearchSession |
getFunctionSearchSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the function
search service for the given vault. |
FunctionSmartVaultSession |
getFunctionSmartVaultSession(Id vaultId,
Proxy proxy)
Gets the session for managing dynamic function vaults for the given
vault.
|
FunctionVaultAssignmentSession |
getFunctionVaultAssignmentSession(Proxy proxy)
Gets the session for assigning function to vault mappings.
|
FunctionVaultSession |
getFunctionVaultSession(Proxy proxy)
Gets the session for retrieving function to vault mappings.
|
QualifierAdminSession |
getQualifierAdminSession(Proxy proxy)
Gets the
OsidSession associated with the qualifier
administration service. |
QualifierAdminSession |
getQualifierAdminSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
admin service for the given vault. |
QualifierHierarchyDesignSession |
getQualifierHierarchyDesignSession(Id qualifierHierarchyId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
hierarchy design service. |
QualifierHierarchySession |
getQualifierHierarchySession(Id qualifierHierarchyId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
hierarchy traversal service. |
QualifierLookupSession |
getQualifierLookupSession(Proxy proxy)
Gets the
OsidSession associated with the qualifier
lookup service. |
QualifierLookupSession |
getQualifierLookupSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
lookup service for the given vault. |
QualifierNotificationSession |
getQualifierNotificationSession(QualifierReceiver qualifierReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to
qualifier changes.
|
QualifierNotificationSession |
getQualifierNotificationSessionForVault(QualifierReceiver qualifierReceiver,
Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
notification service for the given vault. |
QualifierQuerySession |
getQualifierQuerySession(Proxy proxy)
Gets the
OsidSession associated with the qualifier
query service. |
QualifierQuerySession |
getQualifierQuerySessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
query service for the given vault. |
QualifierSearchSession |
getQualifierSearchSession(Proxy proxy)
Gets the
OsidSession associated with the qualifier
search service. |
QualifierSearchSession |
getQualifierSearchSessionForVault(Id vaultId,
Proxy proxy)
Gets the
OsidSession associated with the qualifier
search service for the given vault. |
QualifierSmartVaultSession |
getQualifierSmartVaultSession(Id vaultId,
Proxy proxy)
Gets the session for managing dynamic qualifier vaults for the given
vault.
|
QualifierVaultSession |
getQualifierVaultAssignmentSession(Proxy proxy)
Gets the session for assigning qualifier to vault mappings.
|
QualifierVaultSession |
getQualifierVaultSession(Proxy proxy)
Gets the session for retrieving qualifier to vault mappings.
|
VaultAdminSession |
getVaultAdminSession(Proxy proxy)
Gets the OsidSession associated with the vault administration service.
|
VaultHierarchyDesignSession |
getVaultHierarchyDesignSession(Proxy proxy)
Gets the session designing vault hierarchies.
|
VaultHierarchySession |
getVaultHierarchySession(Proxy proxy)
Gets the session traversing vault hierarchies.
|
VaultLookupSession |
getVaultLookupSession(Proxy proxy)
Gets the OsidSession associated with the vault lookup service.
|
VaultNotificationSession |
getVaultNotificationSession(VaultReceiver vaultReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to vault
service changes.
|
VaultQuerySession |
getVaultQuerySession(Proxy proxy)
Gets the OsidSession associated with the vault query service.
|
VaultSearchSession |
getVaultSearchSession(Proxy proxy)
Gets the OsidSession associated with the vault search service.
|
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(Proxy proxy) throws OperationFailedException
AuthorizationSession
which is responsible for
performing authorization checks.proxy
- a proxyNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAuthorization()
is false
optional
- This method must be implemented if
supportsAuthorization()
is true.
AuthorizationSession getAuthorizationSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
AuthorizationSession
which is responsible for
performing authorization checks for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy an AuthorizationSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
lookup service.proxy
- a proxy AuthorizationLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationLookup()
is false
optional
- This method must be implemented if
supportsAuthorizationLookup()
is true.
AuthorizationLookupSession getAuthorizationLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
lookup service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy an AuthorizationLookupSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
query service.proxy
- a proxy AuthorizationQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationQuery()
is false
optional
- This method must be implemented if
supportsAuthorizationQuery()
is true.
AuthorizationQuerySession getAuthorizationQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
query service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy an AuthorizationQuerySession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
search service.proxy
- a proxy AuthorizationSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationSearch()
is false
optional
- This method must be implemented if
supportsAuthorizationSearch()
is true.
AuthorizationSearchSession getAuthorizationSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
search service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy an AuthorizationSearchSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
administration service.proxy
- a proxy AuthorizationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationAdmin()
is false
optional
- This method must be implemented if
supportsAuthorizationAdmin()
is true.
AuthorizationAdminSession getAuthorizationAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
admin service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy an AuthorizationAdminSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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, Proxy proxy) throws OperationFailedException
authorizationReceiver
- the authorization receiverproxy
- a proxy 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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
notification service for the given vault.authorizationReceiver
- the authorization receivervaultId
- the Id
of the vaultproxy
- a proxy an AuthorizationNotificationSession
NotFoundException
- vaultId
not foundNullArgumentException
- authorizationReceiver
or vaultId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy AuthorizationVaultSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationVault()
is false
optional
- This method must be implemented if
supportsAuthorizationVault()
is true.
AuthorizationVaultAssignmentSession getAuthorizationVaultAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AuthorizationVaultAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationVaultAssignment()
is false
optional
- This method must be implemented if
supportsAuthorizationVaultAssignment()
is
true.
AuthorizationSmartVaultSession getAuthorizationSmartVaultSession(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
vaultId
- the Id
of the vaultproxy
- a proxy AuthorizationSmartVaultSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationSmartVault()
is false
optional
- This method must be implemented if
supportsAuthorizationSmartVault()
is true.
FunctionLookupSession getFunctionLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the function
lookup service.proxy
- a proxy FunctionLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionLookup()
is false
optional
- This method must be implemented if
supportsFunctionLookup()
is true.
FunctionLookupSession getFunctionLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the function
lookup service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy a FunctionLookupSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the function query
service.proxy
- a proxy FunctionQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFunctionQuery()
is false
optional
- This method must be implemented if
supportsFunctionQuery()
is true.
FunctionQuerySession getFunctionQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the function query
service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy FunctionQuerySession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the function
search service.proxy
- a proxy FunctionSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionSearch()
is false
optional
- This method must be implemented if
supportsFunctionSearch()
is true.
FunctionSearchSession getFunctionSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the function
search service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy FunctionSearchSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the function
administration service.proxy
- a proxy FunctionAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFunctionAdmin()
is false
optional
- This method must be implemented if
supportsFunctionAdmin()
is true.
FunctionAdminSession getFunctionAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the function admin
service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy a FunctionAdminSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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, Proxy proxy) throws OperationFailedException
functionReceiver
- the function receiverproxy
- a proxy FunctionNotificationSession
NullArgumentException
- functionReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the function
notification service for the given vault.functionReceiver
- the function receivervaultId
- the Id
of the vaultproxy
- a proxy a FunctionNotificationSession
NotFoundException
- vaultId
not foundNullArgumentException
- functionReceiver
or vaultId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy FunctionVaultSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFunctionVault()
is false
optional
- This method must be implemented if
supportsFunctionVault()
is true.
FunctionVaultAssignmentSession getFunctionVaultAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FunctionVaultAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionVaultAssignment()
is false
optional
- This method must be implemented if
supportsFunctionVaultAssignment()
is true.
FunctionSmartVaultSession getFunctionSmartVaultSession(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
vaultId
- the Id
of a vaultproxy
- a proxy vaultId
not foundNotFoundException
- vaultId
or
proxy
is null
NullArgumentException
- vaultId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFunctionSmartVault()
is false
optional
- This method must be implemented if
supportsFunctionSmartVault()
is true.
QualifierLookupSession getQualifierLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the qualifier
lookup service.proxy
- a proxy QualifierLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierLookup()
is false
optional
- This method must be implemented if
supportsQualifierLookup()
is true.
QualifierLookupSession getQualifierLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
lookup service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy QualifierLookupSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the qualifier
query service.proxy
- a proxy QualifierQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierQuery()
is false
optional
- This method must be implemented if
supportsQualifierSearch()
is true.
QualifierQuerySession getQualifierQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
query service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy QualifierQuerySession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the qualifier
search service.proxy
- a proxy QualifierSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierSearch()
is false
optional
- This method must be implemented if
supportsQualifierSearch()
is true.
QualifierSearchSession getQualifierSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
search service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy QualifierSearchSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the qualifier
administration service.proxy
- a proxy QualifierAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierAdmin()
is false
optional
- This method must be implemented if
supportsQualifierAdmin()
is true.
QualifierAdminSession getQualifierAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
admin service for the given vault.vaultId
- the Id
of the vaultproxy
- a proxy QualifierAdminSession
NotFoundException
- vaultId
not foundNullArgumentException
- vaultId
or
proxy
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, Proxy proxy) throws OperationFailedException
qualifierReceiver
- the qualifier receiverproxy
- a proxy QualifierNotificationSession
NullArgumentException
- qualifierReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
notification service for the given vault.qualifierReceiver
- the qualifier receivervaultId
- the Id
of the vaultproxy
- a proxy QualifierNotificationSession
NotFoundException
- vaultId
not foundNullArgumentException
- qualifierReceiver
or vaultId
or proxy
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, Proxy proxy) 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
hierarchyproxy
- a proxy QualifierHierarchySession
NotFoundException
- qualifierHierarchyId
not foundNullArgumentException
- qualifierHierarchyId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierHierarchy()
is false
optional
- This method must be implemented if
supportsQualifierHierarchy()
is true.
QualifierHierarchyDesignSession getQualifierHierarchyDesignSession(Id qualifierHierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the qualifier
hierarchy design service.qualifierHierarchyId
- the Id
of a qualifier
hierarchyproxy
- a proxy QualifierHierarchyDesignSession
NotFoundException
- qualifierHierarchyId
not foundNullArgumentException
- qualifierHierarchyId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierHierarchyDesign()
is false
optional
- This method must be implemented if
supportsQualifierHierarchyDesign()
is true.
QualifierVaultSession getQualifierVaultSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy QualifierVaultSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierVault()
is false
optional
- This method must be implemented if
supportsQualifierVault()
is true.
QualifierVaultSession getQualifierVaultAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy QualifierVaultAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierVaultAssignment()
is false
optional
- This method must be implemented if
supportsQualifierVaultAssignment()
is true.
QualifierSmartVaultSession getQualifierSmartVaultSession(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
vaultId
- the Id
of a vaultproxy
- a proxy vaultId
not foundNotFoundException
- vaultId
or
proxy
is null
NullArgumentException
- vaultId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQualifierSmartVault()
is false
optional
- This method must be implemented if
supportsQualifierSmartVault()
is true.
VaultLookupSession getVaultLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy VaultLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultLookup()
is false
optional
- This method must be implemented if
supportsVaultLookup()
is true. VaultQuerySession getVaultQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy VaultQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultQuery() is
false
optional
- This method must be implemented if
supportsVaultQuery()
is true. VaultSearchSession getVaultSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy VaultSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultSearch()
is false
optional
- This method must be implemented if
supportsVaultSearch()
is true. VaultAdminSession getVaultAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy VaultAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsVaultAdmin() is
false
optional
- This method must be implemented if
supportsVaultAdmin()
is true. VaultNotificationSession getVaultNotificationSession(VaultReceiver vaultReceiver, Proxy proxy) throws OperationFailedException
vaultReceiver
- the vault receiverproxy
- a proxy VaultNotificationSession
NullArgumentException
- vaultReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsVaultNotification() is false
optional
- This method must be implemented if
supportsVaultNotification()
is true. VaultHierarchySession getVaultHierarchySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy VaultHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsVaultHierarchy() is false
optional
- This method must be implemented if
supportsVaultHierarchy()
is true. VaultHierarchyDesignSession getVaultHierarchyDesignSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy VaultHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsVaultHierarchyDesign() is false
optional
- This method must be implemented if
supportsVaultHierarchyDesign()
is true. AuthorizationBatchProxyManager getAuthorizationBatchProxyManager() throws OperationFailedException
AuthorizationBatchProxyManager.
AuthorizationBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationBatch() is false
optional
- This method must be implemented if
supportsAuthorizationBatch()
is true. AuthorizationRulesProxyManager getAuthorizationRulesProxyManager() throws OperationFailedException
AuthorizationRulesProxyManager.
AuthorizationRulesProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationRules() is false
optional
- This method must be implemented if
supportsAuthorizationRules()
is true.