public interface AuthorizationRulesManager extends OsidManager, AuthorizationRulesProfile
The authorization rules manager provides access to authorization rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
AuthorizationEnablerLookupSession:
a session to
retrieve authorization enablers AuthorizationEnablerQuerySession:
a session to
query for authorization enablers AuthorizationEnablerSearchSession:
a session to
search for authorization enablers AuthorizationEnablerAdminSession:
a session to
create and delete authorization enablers AuthorizationEnablerNotificationSession:
a session
to receive notifications pertaining to authorization enabler changes
AuthorizationEnablerVaultSession:
a session to
look up authorization enabler vault mappings AuthorizationEnablerVaultAssignmentSession:
a
session to manage authorization enabler to vault mappings AuthorizationEnablerSmartVaultSession:
a session
to manage dynamic vaults of authorization enablers AuthorizationEnablerRuleLookupSession:
a session
to look up authorization enabler to authorization mappings AuthorizationEnablerRuleApplicationSession:
a
session to assign authorization enablers to authorizations Modifier and Type | Method and Description |
---|---|
AuthorizationEnablerAdminSession |
getAuthorizationEnablerAdminSession()
Gets the
OsidSession associated with the authorization
enabler administration service. |
AuthorizationEnablerAdminSession |
getAuthorizationEnablerAdminSessionForVault(Id vaultId)
Gets the
OsidSession associated with the authorization
enabler administration service for the given vault. |
AuthorizationEnablerLookupSession |
getAuthorizationEnablerLookupSession()
Gets the
OsidSession associated with the authorization
enabler lookup service. |
AuthorizationEnablerLookupSession |
getAuthorizationEnablerLookupSessionForVault(Id vaultId)
Gets the
OsidSession associated with the authorization
enabler lookup service for the given vault. |
AuthorizationEnablerNotificationSession |
getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver)
Gets the
OsidSession associated with the authorization
enabler notification service. |
AuthorizationEnablerNotificationSession |
getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver,
Id vaultId)
Gets the
OsidSession associated with the authorization
enabler notification service for the given vault. |
AuthorizationEnablerQuerySession |
getAuthorizationEnablerQuerySession()
Gets the
OsidSession associated with the authorization
enabler query service. |
AuthorizationEnablerQuerySession |
getAuthorizationEnablerQuerySessionForVault(Id vaultId)
Gets the
OsidSession associated with the authorization
enabler query service for the given vault. |
AuthorizationEnablerRuleApplicationSession |
getAuthorizationEnablerRuleApplicationSession()
Gets the
OsidSession associated with the authorization
enabler assignment service to apply enablers to vaults. |
AuthorizationEnablerRuleApplicationSession |
getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId)
Gets the
OsidSession associated with the authorization
enabler assignment service for the given vault to apply enablers to
vaults. |
AuthorizationEnablerRuleLookupSession |
getAuthorizationEnablerRuleLookupSession()
Gets the
OsidSession associated with the authorization
enabler authorization mapping lookup service. |
AuthorizationEnablerRuleLookupSession |
getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId)
Gets the
OsidSession associated with the authorization
enabler mapping lookup service for the given vault. |
AuthorizationEnablerSearchSession |
getAuthorizationEnablerSearchSession()
Gets the
OsidSession associated with the authorization
enabler search service. |
AuthorizationEnablerSearchSession |
getAuthorizationEnablerSearchSessionForVault(Id vaultId)
Gets the
OsidSession associated with the authorization
enablers earch service for the given vault. |
AuthorizationEnablerSmartVaultSession |
getAuthorizationEnablerSmartVaultSession(Id vaultId)
Gets the
OsidSession to manage authorization enabler
smart vaults. |
AuthorizationEnablerVaultAssignmentSession |
getAuthorizationEnablerVaultAssignmentSession()
Gets the
OsidSession associated with assigning
authorization enablers to vaults for authorization. |
AuthorizationEnablerVaultSession |
getAuthorizationEnablerVaultSession()
Gets the
OsidSession to lookup authorization
enabler/vault mappings for authorization enablers. |
changeBranch, initialize, rollbackService
close
getAuthorizationEnablerRecordTypes, getAuthorizationEnablerSearchRecordTypes, supportsAuthorizationEnablerAdmin, supportsAuthorizationEnablerLookup, supportsAuthorizationEnablerNotification, supportsAuthorizationEnablerQuery, supportsAuthorizationEnablerRecordType, supportsAuthorizationEnablerRuleApplication, supportsAuthorizationEnablerRuleLookup, supportsAuthorizationEnablerSearch, supportsAuthorizationEnablerSearchRecordType, supportsAuthorizationEnablerSmartVault, supportsAuthorizationEnablerVault, supportsAuthorizationEnablerVaultAssignment, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the authorization
enabler lookup service. AuthorizationEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerLookup()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerLookup()
is
true.
AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler lookup service for the given vault.vaultId
- the Id
of the Vault
AuthorizationEnablerLookupSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerLookup()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the authorization
enabler query service. AuthorizationEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerQuery()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerQuery()
is
true.
AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler query service for the given vault.vaultId
- the Id
of the Vault
AuthorizationEnablerQuerySession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerQuery()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the authorization
enabler search service. AuthorizationEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerSearch()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerSearch()
is
true.
AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enablers earch service for the given vault.vaultId
- the Id
of the Vault
AuthorizationEnablerSearchSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerSearch()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the authorization
enabler administration service. AuthorizationEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerAdmin()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerAdmin()
is
true.
AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler administration service for the given vault.vaultId
- the Id
of the Vault
AuthorizationEnablerAdminSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerAdmin()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver) throws OperationFailedException
OsidSession
associated with the authorization
enabler notification service.authorizationEnablerReceiver
- the notification callback AuthorizationEnablerNotificationSession
NullArgumentException
-
authorizationEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerNotification()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerNotification()
is
true.
AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver, Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler notification service for the given vault.authorizationEnablerReceiver
- the notification callbackvaultId
- the Id
of the Vault
AuthorizationEnablerNotificationSession
NotFoundException
- no vault found by the given
Id
NullArgumentException
-
authorizationEnablerReceiver
or vaultId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerNotification()
and
supportsVisibleFederation()
are
true.
AuthorizationEnablerVaultSession getAuthorizationEnablerVaultSession() throws OperationFailedException
OsidSession
to lookup authorization
enabler/vault mappings for authorization enablers. AuthorizationEnablerVaultSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerVault()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerVault()
is
true.
AuthorizationEnablerVaultAssignmentSession getAuthorizationEnablerVaultAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
authorization enablers to vaults for authorization. AuthorizationEnablerVaultAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerVaultAssignment()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerVaultAssignment()
is
true.
AuthorizationEnablerSmartVaultSession getAuthorizationEnablerSmartVaultSession(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
to manage authorization enabler
smart vaults.vaultId
- the Id
of the Vault
AuthorizationEnablerSmartVaultSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerSmartVault()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerSmartVault()
is
true.
AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the authorization
enabler authorization mapping lookup service. AuthorizationEnablerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleLookup()
is
true.
AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler mapping lookup service for the given vault.vaultId
- the Id
of the Vault
AuthorizationEnablerRuleLookupSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleLookup()
and
supportsVisibleFederation()
are
true.
AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the authorization
enabler assignment service to apply enablers to vaults. AuthorizationEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleApplication()
is
true.
AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler assignment service for the given vault to apply enablers to
vaults.vaultId
- the Id
of the Vault
AuthorizationEnablerRuleApplicationSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleApplication()
and
supportsVisibleFederation()
are true