public interface AuthorizationEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply AuthorizationEnablers
to Authorizations.
An Authorization
with multiple AuthorizationEnablers
means any positive rule
evaluation across the enablers result in an effective
Authorization.
Modifier and Type | Method and Description |
---|---|
void |
assignAuthorizationEnablerToAuthorization(Id authorizationEnablerId,
Id authorizationId)
Adds an existing
AuthorizationEnabler to an
Authorization. |
boolean |
canAssignAuthorizationEnablers()
Tests if this user can alter authorization enabler/authorization
mappings.
|
boolean |
canSequenceAuthorizationEnablers()
Tests if this user can order
AuthorizationEnablers. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
moveAuthorizationEnablerAhead(Id authorizationEnablerId,
Id authorizationId,
Id referenceId)
Reorders authorization enablers for an authorization by moving the
specified authorization enabler in front of a reference authorization
enabler.
|
void |
moveAuthorizationEnablerBehind(Id authorizationEnablerId,
Id authorizationId,
Id referenceId)
Reorders authorization enablers for an authorization by moving the
specified authorization enabler behind a reference authorization
enabler.
|
void |
orderAuthorizationEnablers(Id[] authorizationEnablerIds,
Id authorizationId)
Reorders a set of authorization enablers for an authorization.
|
void |
unassignAuthorizationEnablerFromAuthorization(Id authorizationEnablerId,
Id authorizationId)
Removes an
AuthorizationEnabler from an
Authorization. |
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 canAssignAuthorizationEnablers()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignAuthorizationEnablerToAuthorization(Id authorizationEnablerId, Id authorizationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnabler
to an
Authorization.
authorizationEnablerId
- the Id
of the
AuthorizationEnabler
authorizationId
- the Id
of the
Authorization
AlreadyExistsException
- authorizationEnablerId
already assigned to authorizationId
NotFoundException
- authorizationEnablerId
or authorizationId
not foundNullArgumentException
- authorizationEnablerId
or authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuthorizationEnablerFromAuthorization(Id authorizationEnablerId, Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnabler
from an
Authorization.
authorizationEnablerId
- the Id
of the
AuthorizationEnabler
authorizationId
- the Id
of the
Authorization
NotFoundException
- authorizationEnablerId
or authorizationId
not found or not
mappedNullArgumentException
- authorizationEnablerId
or authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceAuthorizationEnablers()
AuthorizationEnablers.
A
return of true does not guarantee successful authorization. A return
of false indicates that it is known sequencing operations will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer sequencing operations to an
unauthorized user. false
if AuthorizationEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveAuthorizationEnablerAhead(Id authorizationEnablerId, Id authorizationId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
authorizationEnablerId
- the Id
of an
AuthorizationEnabler
authorizationId
- the Id
of an
Authorization
referenceId
- the reference authorization enabler Id
NotFoundException
- authorizationEnablerId,
authorizationId,
or referenceId
not
found or, authorizationEnablerId
or
referenceId
not related to authorizationId
NullArgumentException
- authorizationEnablerId,
authorizationId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveAuthorizationEnablerBehind(Id authorizationEnablerId, Id authorizationId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
authorizationEnablerId
- the Id
of an
AuthorizationEnabler
authorizationId
- the Id
of an
Authorization
referenceId
- the reference authorization enabler Id
NotFoundException
- authorizationEnabelrId,
authorizationId,
or referenceId
not
found or, authorizationEnablerId
or
referenceId
not related to authorizationId
NullArgumentException
- authorizationEnablerId,
authorizationId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderAuthorizationEnablers(Id[] authorizationEnablerIds, Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
authorizationEnablerIds
- the Ids
for a set of
AuthorizationEnablers
authorizationId
- the Id
of an
Authorization
NotFoundException
- authorizationId
not
found or, an authorizationEnablerId
not related
to authorizationId
NullArgumentException
- authorizationEnablerIds
or authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.