Package io.deephaven.enterprise.acl

Interface EdgeAclProvider

All Known Implementing Classes:
EdgeAclImpl
public interface EdgeAclProvider
Objects that implement this interface provide ACLs for tables based on the requesting user at request time, as opposed to SourceAclProvider which applies ACLS to the table when it is fetched from the data source.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    EdgeAclProvider.Builder
    A Builder to construct a set of ACLs to apply to a table based on the user fetching it.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ACL_ATTRIBUTE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addAcl(@NotNull String group, @NotNull Object value)
     
    default Table
    applyTo(@NotNull Table table)
    Attach the ACLs to the specified table
    static EdgeAclProvider.Builder
    builder()
    Get a EdgeAclProvider.Builder to create ACLs for a table.
    @Nullable ColumnAcl
    getColumnFilters(@NotNull AclSupport support, @NotNull io.deephaven.enterprise.auth.UserContext userContext, @NotNull String[] columnNames, boolean isRefreshing)
    Get the column ACLs to apply to requested tables.
    @NotNull Set<String>
    getGroups()
    Get the set of groups that may access the table this ACL guards.
    @Nullable Collection<WhereFilter>[]
    getRowFilters(@NotNull AclSupport support, @NotNull io.deephaven.enterprise.auth.UserContext userContext, boolean isRefreshing)
    Get the set of WhereFilters that should be disjunctively applied to requested tables.

  • Field Details

  • Method Details

    • addAcl

      static void addAcl(@NotNull @NotNull String group, @NotNull @NotNull Object value)

    • builder

      @ScriptApi static EdgeAclProvider.Builder builder()
      Get a EdgeAclProvider.Builder to create ACLs for a table.
      Returns:
      a new EdgeAclProvider.Builder

    • getRowFilters

      @Nullable @Nullable Collection<WhereFilter>[] getRowFilters(@NotNull @NotNull AclSupport support, @NotNull @NotNull io.deephaven.enterprise.auth.UserContext userContext, boolean isRefreshing)
      Get the set of WhereFilters that should be disjunctively applied to requested tables.
      Parameters:
      support - the support object
      userContext - the user to generate the ACL for
      isRefreshing - if the table is refreshing
      Returns:
      the collection of row ACLs to be disjunctively applied to the table.

    • getColumnFilters

      @Nullable @Nullable ColumnAcl getColumnFilters(@NotNull @NotNull AclSupport support, @NotNull @NotNull io.deephaven.enterprise.auth.UserContext userContext, @NotNull @NotNull String[] columnNames, boolean isRefreshing)
      Get the column ACLs to apply to requested tables.
      Parameters:
      support - the support object
      userContext - the user to generate the ACL for
      columnNames - the columns to fetch ACLs for
      isRefreshing - if the table is refreshing
      Returns:
      the column ACLs

    • getGroups

      @NotNull @NotNull Set<String> getGroups()
      Get the set of groups that may access the table this ACL guards.
      Returns:
      the set of groups that may access the table

    • applyTo

      @FinalDefault default Table applyTo(@NotNull @NotNull Table table)
      Attach the ACLs to the specified table
      Parameters:
      table - the table to apply ACLs to
      Returns:
      the table with ACLs applied