Package de.espirit.firstspirit.client.plugin.dataaccess.aspects

Interface DataAccessControlling

public interface DataAccessControlling
Aspect providing means to ensure access to data via a bound 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).

Since:
5.2.180803

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    DataAccessControlling.AccessDeniedException
    Exception thrown, when access to the session's data is denied.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SessionAspectType<DataAccessControlling>
    TYPE
    Aspect providing means to ensure access to data.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getAcquireAccessLabel()
    Provides a label being used for an action to acquire access.
    void
    requireAccess(@NotNull 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.