public interface DataAccessControlling
DataAccessSession
.
The operational workflow for users of this aspect shall use:
verifyAccess()
to find out about, whether access to the session's data is granted;requireAccess(BaseContext)
to instruct the session to acquire access to data, while
providing the execution context to allow for appropriate options for dialogs, if applicable.
Note: To provide localized messages, the ApplicationAgent
can be employed, optionally provided by
the given base context (e.g., given via the data session).
Modifier and Type | Interface and Description |
---|---|
static class |
DataAccessControlling.AccessDeniedException
Exception thrown, when access to the session's data is denied.
|
Modifier and Type | Field and Description |
---|---|
static SessionAspectType<DataAccessControlling> |
TYPE
Aspect providing means to ensure access to data.
|
Modifier and Type | Method and Description |
---|---|
String |
getAcquireAccessLabel()
Provides a label being used for an action to acquire access.
|
void |
requireAccess(BaseContext context)
Requires the session to enable accessing its data and provide the current access state.
|
void |
verifyAccess()
Verifies the current accessibility on the session's data.
|
static final SessionAspectType<DataAccessControlling> TYPE
void verifyAccess() throws DataAccessControlling.AccessDeniedException
DataAccessControlling.AccessDeniedException
- If access is denied.void requireAccess(@NotNull BaseContext context) throws DataAccessControlling.AccessDeniedException
context
- The context to operate in, providing environment information.DataAccessControlling.AccessDeniedException
- If access is denied.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210