public interface AuthorizationEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve AuthorizationEnabler
to Authorization
mappings. An Authorization
with multiple AuthorizationEnablers
means any
positive rule evaluation across the enablers result in an effective
Authorization.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuthorizationEnablerRules()
Tests if this user can perform lookups of authorization
enabler/authorization mappings.
|
IdList |
getAuthorizationEnablerIdsForAuthorization(Id authorizationId)
Gets the
AuthorizationEnabler Id associated with an
Authorization. |
AuthorizationEnablerList |
getAuthorizationEnablersForAuthorization(Id authorizationId)
Gets the
AuthorizationEnabler associated with an
Authorization. |
IdList |
getAuthorizationIdsForAuthorizationEnabler(Id authorizationEnablerId)
Gets the
Authorization Ids mapped to an
AuthorizationEnabler. |
AuthorizationList |
getAuthorizationsForAuthorizationEnabler(Id authorizationEnablerId)
Gets the
Authorizations mapped to an
AuthorizationEnabler. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
useComparativeAuthorizationEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
void |
usePlenaryAuthorizationEnablerRuleView()
A complete view of the
AuthorizationEnabler and
Authorization returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAuthorizationEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAuthorizationEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryAuthorizationEnablerRuleView()
AuthorizationEnabler
and
Authorization
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. IdList getAuthorizationEnablerIdsForAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnabler Id
associated with an
Authorization.
authorizationId
- Id
of the Authorization
Ids
NotFoundException
- authorizationId
is
not foundNullArgumentException
- authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationEnablerList getAuthorizationEnablersForAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnabler
associated with an
Authorization.
authorizationId
- Id
of the Authorization
NotFoundException
- authorizationId
is
not foundNullArgumentException
- authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuthorizationIdsForAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Authorization
Ids
mapped to an
AuthorizationEnabler.
authorizationEnablerId
- Id
of an
AuthorizationEnabler
Ids
NotFoundException
- authorizationEnablerId
is not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationList getAuthorizationsForAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Authorizations
mapped to an
AuthorizationEnabler.
authorizationEnablerId
- Id
of an
AuthorizationEnabler
NotFoundException
- authorizationEnablerId
is not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.