Package org.elasticsearch.client.security.user.privileges

Class AbstractIndicesPrivileges

java.lang.Object
org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges
Direct Known Subclasses:
IndicesPrivileges, UserIndicesPrivileges
public abstract class AbstractIndicesPrivileges extends Object

  • Field Details

    • indices

      protected final Set<String> indices

    • privileges

      protected final Set<String> privileges

    • allowRestrictedIndices

      protected final boolean allowRestrictedIndices

  • Method Details

    • getIndices

      public Set<String> getIndices()
      The indices names covered by the privileges.

    • getPrivileges

      public Set<String> getPrivileges()
      The privileges acting over indices. There is a canonical predefined set of such privileges, but the String datatype allows for flexibility in defining finer grained privileges.

    • allowRestrictedIndices

      public boolean allowRestrictedIndices()
      True if the privileges cover restricted internal indices too. Certain indices are reserved for internal services and should be transparent to ordinary users. For that matter, when granting privileges, you also have to toggle this flag to confirm that all indices, including restricted ones, are in the scope of this permission. By default this is false.

    • isUsingDocumentLevelSecurity

      public abstract boolean isUsingDocumentLevelSecurity()
      If true some documents might not be visible. Only the documents matching query will be readable.

    • isUsingFieldLevelSecurity

      public abstract boolean isUsingFieldLevelSecurity()
      If true some document fields might not be visible.