Module org.elasticsearch.xcore
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 ClassesModifier and TypeInterfaceDescriptionstatic enumCategories 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.ParamsNested 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 TypeMethodDescriptionThe category under which this privilege should be rendered when output as XContent.org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) AConfigurableClusterPrivilegeshould generate a fragment ofXContent, 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
buildPermissionMethods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable
getWriteableNameMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Method Details
-
getCategory
ConfigurableClusterPrivilege.Category 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 AConfigurableClusterPrivilegeshould generate a fragment ofXContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).- Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-