Interface ConfigurableClusterPrivilege

All Superinterfaces:
ClusterPrivilege, NamedWriteable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment, Writeable
All Known Implementing Classes:
ConfigurableClusterPrivileges.ManageApplicationPrivileges, ConfigurableClusterPrivileges.ManageRolesPrivilege, ConfigurableClusterPrivileges.WriteProfileDataPrivileges

public interface ConfigurableClusterPrivilege extends NamedWriteable, org.elasticsearch.xcontent.ToXContentFragment, ClusterPrivilege
A ConfigurableClusterPrivilege is a form of ClusterPrivilege that can be configured by an Elasticsearch security administrator within a RoleDescriptor.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Categories exist for to segment privileges for the purposes of rendering to XContent.

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Field Summary

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Method Summary

    Modifier and Type
    Method
    Description
    The category under which this privilege should be rendered when output as XContent.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
    A ConfigurableClusterPrivilege should generate a fragment of XContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).

    Methods inherited from interface org.elasticsearch.xpack.core.security.authz.privilege.ClusterPrivilege

    buildPermission

    Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

    getWriteableName

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment

    Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

    writeTo
  • Method Details

    • getCategory

      The category under which this privilege should be rendered when output as XContent.
    • toXContent

      org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      A ConfigurableClusterPrivilege should generate a fragment of XContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException