• Home
• org.elasticsearch.client
• elasticsearch-rest-high-level-client
• 7.17.25
• source code
• Role.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.elasticsearch.client.security.user.privileges.Role Maven / Gradle / Ivy

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.client.security.user.privileges;

import org.elasticsearch.common.Strings;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.core.Tuple;
import org.elasticsearch.xcontent.ConstructingObjectParser;
import org.elasticsearch.xcontent.ObjectParser.ValueType;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.XContentParser;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

import static org.elasticsearch.xcontent.ConstructingObjectParser.optionalConstructorArg;

/**
 * Represents an aggregation of privileges.
 */
public final class Role {

    public static final ParseField CLUSTER = new ParseField("cluster");
    public static final ParseField GLOBAL = new ParseField("global");
    public static final ParseField INDICES = new ParseField("indices");
    public static final ParseField APPLICATIONS = new ParseField("applications");
    public static final ParseField RUN_AS = new ParseField("run_as");
    public static final ParseField METADATA = new ParseField("metadata");
    public static final ParseField TRANSIENT_METADATA = new ParseField("transient_metadata");

    @SuppressWarnings("unchecked")
    public static final ConstructingObjectParser>, String> PARSER = new ConstructingObjectParser<>(
        "role_descriptor",
        false,
        (constructorObjects, roleName) -> {
            // Don't ignore unknown fields. It is dangerous if the object we parse is also
            // part of a request that we build later on, and the fields that we now ignore
            // will end up being implicitly set to null in that request.
            int i = 0;
            final Collection clusterPrivileges = (Collection) constructorObjects[i++];
            final GlobalPrivileges globalApplicationPrivileges = (GlobalPrivileges) constructorObjects[i++];
            final Collection indicesPrivileges = (Collection) constructorObjects[i++];
            final Collection applicationResourcePrivileges = (Collection<
                ApplicationResourcePrivileges>) constructorObjects[i++];
            final Collection runAsPrivilege = (Collection) constructorObjects[i++];
            final Map metadata = (Map) constructorObjects[i++];
            final Map transientMetadata = (Map) constructorObjects[i];
            return new Tuple<>(
                new Role(
                    roleName,
                    clusterPrivileges,
                    globalApplicationPrivileges,
                    indicesPrivileges,
                    applicationResourcePrivileges,
                    runAsPrivilege,
                    metadata
                ),
                transientMetadata != null ? Collections.unmodifiableMap(transientMetadata) : Collections.emptyMap()
            );
        }
    );

    static {
        PARSER.declareStringArray(optionalConstructorArg(), CLUSTER);
        PARSER.declareObject(optionalConstructorArg(), (parser, c) -> GlobalPrivileges.PARSER.parse(parser, null), GLOBAL);
        PARSER.declareFieldArray(
            optionalConstructorArg(),
            (parser, c) -> IndicesPrivileges.PARSER.parse(parser, null),
            INDICES,
            ValueType.OBJECT_ARRAY
        );
        PARSER.declareFieldArray(
            optionalConstructorArg(),
            (parser, c) -> ApplicationResourcePrivileges.PARSER.parse(parser, null),
            APPLICATIONS,
            ValueType.OBJECT_ARRAY
        );
        PARSER.declareStringArray(optionalConstructorArg(), RUN_AS);
        PARSER.declareObject(optionalConstructorArg(), (parser, c) -> parser.map(), METADATA);
        PARSER.declareObject(optionalConstructorArg(), (parser, c) -> parser.map(), TRANSIENT_METADATA);
    }

    private final String name;
    private final Set clusterPrivileges;
    private final @Nullable GlobalPrivileges globalPrivileges;
    private final Set indicesPrivileges;
    private final Set applicationPrivileges;
    private final Set runAsPrivilege;
    private final Map metadata;

    private Role(
        String name,
        @Nullable Collection clusterPrivileges,
        @Nullable GlobalPrivileges globalPrivileges,
        @Nullable Collection indicesPrivileges,
        @Nullable Collection applicationPrivileges,
        @Nullable Collection runAsPrivilege,
        @Nullable Map metadata
    ) {
        if (Strings.hasText(name) == false) {
            throw new IllegalArgumentException("role name must be provided");
        } else {
            this.name = name;
        }
        // no cluster privileges are granted unless otherwise specified
        this.clusterPrivileges = Collections.unmodifiableSet(
            clusterPrivileges != null ? new HashSet<>(clusterPrivileges) : Collections.emptySet()
        );
        this.globalPrivileges = globalPrivileges;
        // no indices privileges are granted unless otherwise specified
        this.indicesPrivileges = Collections.unmodifiableSet(
            indicesPrivileges != null ? new HashSet<>(indicesPrivileges) : Collections.emptySet()
        );
        // no application resource privileges are granted unless otherwise specified
        this.applicationPrivileges = Collections.unmodifiableSet(
            applicationPrivileges != null ? new HashSet<>(applicationPrivileges) : Collections.emptySet()
        );
        // no run as privileges are granted unless otherwise specified
        this.runAsPrivilege = Collections.unmodifiableSet(runAsPrivilege != null ? new HashSet<>(runAsPrivilege) : Collections.emptySet());
        this.metadata = metadata != null ? Collections.unmodifiableMap(metadata) : Collections.emptyMap();
    }

    public String getName() {
        return name;
    }

    public Set getClusterPrivileges() {
        return clusterPrivileges;
    }

    public GlobalPrivileges getGlobalPrivileges() {
        return globalPrivileges;
    }

    public Set getIndicesPrivileges() {
        return indicesPrivileges;
    }

    public Set getApplicationPrivileges() {
        return applicationPrivileges;
    }

    public Set getRunAsPrivilege() {
        return runAsPrivilege;
    }

    public Map getMetadata() {
        return metadata;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Role that = (Role) o;
        return name.equals(that.name)
            && clusterPrivileges.equals(that.clusterPrivileges)
            && Objects.equals(globalPrivileges, that.globalPrivileges)
            && indicesPrivileges.equals(that.indicesPrivileges)
            && applicationPrivileges.equals(that.applicationPrivileges)
            && runAsPrivilege.equals(that.runAsPrivilege)
            && metadata.equals(that.metadata);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, clusterPrivileges, globalPrivileges, indicesPrivileges, applicationPrivileges, runAsPrivilege, metadata);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder("{");
        sb.append("Name=").append(name).append(",");
        if (false == clusterPrivileges.isEmpty()) {
            sb.append("ClusterPrivileges=");
            sb.append(clusterPrivileges.toString());
            sb.append(", ");
        }
        if (globalPrivileges != null) {
            sb.append("GlobalPrivileges=");
            sb.append(globalPrivileges.toString());
            sb.append(", ");
        }
        if (false == indicesPrivileges.isEmpty()) {
            sb.append("IndicesPrivileges=");
            sb.append(indicesPrivileges.toString());
            sb.append(", ");
        }
        if (false == applicationPrivileges.isEmpty()) {
            sb.append("ApplicationPrivileges=");
            sb.append(applicationPrivileges.toString());
            sb.append(", ");
        }
        if (false == runAsPrivilege.isEmpty()) {
            sb.append("RunAsPrivilege=");
            sb.append(runAsPrivilege.toString());
            sb.append(", ");
        }
        if (false == metadata.isEmpty()) {
            sb.append("Metadata=[");
            sb.append(metadata.toString());
            sb.append("], ");
        }
        sb.append("}");
        return sb.toString();
    }

    public static Tuple> fromXContent(XContentParser parser, String name) {
        return PARSER.apply(parser, name);
    }

    public static Builder builder() {
        return new Builder();
    }

    public static final class Builder {

        private @Nullable String name = null;
        private @Nullable Collection clusterPrivileges = null;
        private @Nullable GlobalPrivileges globalApplicationPrivileges = null;
        private @Nullable Collection indicesPrivileges = null;
        private @Nullable Collection applicationResourcePrivileges = null;
        private @Nullable Collection runAsPrivilege = null;
        private @Nullable Map metadata = null;

        private Builder() {}

        public Builder clone(Role role) {
            return this.name(role.name)
                .clusterPrivileges(role.clusterPrivileges)
                .globalApplicationPrivileges(role.globalPrivileges)
                .indicesPrivileges(role.indicesPrivileges)
                .applicationResourcePrivileges(role.applicationPrivileges)
                .runAsPrivilege(role.runAsPrivilege)
                .metadata(role.metadata);
        }

        public Builder name(String name) {
            if (Strings.hasText(name) == false) {
                throw new IllegalArgumentException("role name must be provided");
            } else {
                this.name = name;
            }
            return this;
        }

        public Builder clusterPrivileges(String... clusterPrivileges) {
            return clusterPrivileges(
                Arrays.asList(Objects.requireNonNull(clusterPrivileges, "Cluster privileges cannot be null. Pass an empty array instead."))
            );
        }

        public Builder clusterPrivileges(Collection clusterPrivileges) {
            this.clusterPrivileges = Objects.requireNonNull(
                clusterPrivileges,
                "Cluster privileges cannot be null. Pass an empty collection instead."
            );
            return this;
        }

        public Builder globalApplicationPrivileges(GlobalPrivileges globalApplicationPrivileges) {
            this.globalApplicationPrivileges = globalApplicationPrivileges;
            return this;
        }

        public Builder indicesPrivileges(IndicesPrivileges... indicesPrivileges) {
            return indicesPrivileges(
                Arrays.asList(Objects.requireNonNull(indicesPrivileges, "Indices privileges cannot be null. Pass an empty array instead."))
            );
        }

        public Builder indicesPrivileges(Collection indicesPrivileges) {
            this.indicesPrivileges = Objects.requireNonNull(
                indicesPrivileges,
                "Indices privileges cannot be null. Pass an empty collection instead."
            );
            return this;
        }

        public Builder applicationResourcePrivileges(ApplicationResourcePrivileges... applicationResourcePrivileges) {
            return applicationResourcePrivileges(
                Arrays.asList(
                    Objects.requireNonNull(
                        applicationResourcePrivileges,
                        "Application resource privileges cannot be null. Pass an empty array instead."
                    )
                )
            );
        }

        public Builder applicationResourcePrivileges(Collection applicationResourcePrivileges) {
            this.applicationResourcePrivileges = Objects.requireNonNull(
                applicationResourcePrivileges,
                "Application resource privileges cannot be null. Pass an empty collection instead."
            );
            return this;
        }

        public Builder runAsPrivilege(String... runAsPrivilege) {
            return runAsPrivilege(
                Arrays.asList(Objects.requireNonNull(runAsPrivilege, "Run as privilege cannot be null. Pass an empty array instead."))
            );
        }

        public Builder runAsPrivilege(Collection runAsPrivilege) {
            this.runAsPrivilege = Objects.requireNonNull(
                runAsPrivilege,
                "Run as privilege cannot be null. Pass an empty collection instead."
            );
            return this;
        }

        public Builder metadata(Map metadata) {
            this.metadata = Objects.requireNonNull(metadata, "Metadata cannot be null. Pass an empty map instead.");
            return this;
        }

        public Role build() {
            return new Role(
                name,
                clusterPrivileges,
                globalApplicationPrivileges,
                indicesPrivileges,
                applicationResourcePrivileges,
                runAsPrivilege,
                metadata
            );
        }
    }

    /**
     * Canonical cluster privilege names. There is no enforcement to only use these.
     */
    public static class ClusterPrivilegeName {
        public static final String NONE = "none";
        public static final String ALL = "all";
        public static final String MONITOR = "monitor";
        public static final String MONITOR_TRANSFORM_DEPRECATED = "monitor_data_frame_transforms";
        public static final String MONITOR_TRANSFORM = "monitor_transform";
        public static final String MONITOR_ML = "monitor_ml";
        public static final String MONITOR_TEXT_STRUCTURE = "monitor_text_structure";
        public static final String MONITOR_WATCHER = "monitor_watcher";
        public static final String MONITOR_ROLLUP = "monitor_rollup";
        public static final String MANAGE = "manage";
        public static final String MANAGE_TRANSFORM_DEPRECATED = "manage_data_frame_transforms";
        public static final String MANAGE_TRANSFORM = "manage_transform";
        public static final String MANAGE_ML = "manage_ml";
        public static final String MANAGE_WATCHER = "manage_watcher";
        public static final String MANAGE_ROLLUP = "manage_rollup";
        public static final String MANAGE_INDEX_TEMPLATES = "manage_index_templates";
        public static final String MANAGE_INGEST_PIPELINES = "manage_ingest_pipelines";
        public static final String READ_PIPELINE = "read_pipeline";
        public static final String TRANSPORT_CLIENT = "transport_client";
        public static final String MANAGE_SECURITY = "manage_security";
        public static final String MANAGE_SAML = "manage_saml";
        public static final String MANAGE_OIDC = "manage_oidc";
        public static final String MANAGE_TOKEN = "manage_token";
        public static final String MANAGE_PIPELINE = "manage_pipeline";
        public static final String MANAGE_AUTOSCALING = "manage_autoscaling";
        public static final String MANAGE_CCR = "manage_ccr";
        public static final String READ_CCR = "read_ccr";
        public static final String MANAGE_ILM = "manage_ilm";
        public static final String READ_ILM = "read_ilm";
        public static final String MANAGE_ENRICH = "manage_enrich";
        public static final String[] ALL_ARRAY = new String[] {
            NONE,
            ALL,
            MONITOR,
            MONITOR_TRANSFORM_DEPRECATED,
            MONITOR_TRANSFORM,
            MONITOR_ML,
            MONITOR_TEXT_STRUCTURE,
            MONITOR_WATCHER,
            MONITOR_ROLLUP,
            MANAGE,
            MANAGE_TRANSFORM_DEPRECATED,
            MANAGE_TRANSFORM,
            MANAGE_ML,
            MANAGE_WATCHER,
            MANAGE_ROLLUP,
            MANAGE_INDEX_TEMPLATES,
            MANAGE_INGEST_PIPELINES,
            READ_PIPELINE,
            TRANSPORT_CLIENT,
            MANAGE_SECURITY,
            MANAGE_SAML,
            MANAGE_OIDC,
            MANAGE_TOKEN,
            MANAGE_PIPELINE,
            MANAGE_AUTOSCALING,
            MANAGE_CCR,
            READ_CCR,
            MANAGE_ILM,
            READ_ILM,
            MANAGE_ENRICH };
    }

    /**
     * Canonical index privilege names. There is no enforcement to only use these.
     */
    public static class IndexPrivilegeName {
        public static final String NONE = "none";
        public static final String ALL = "all";
        public static final String READ = "read";
        public static final String READ_CROSS = "read_cross_cluster";
        public static final String CREATE = "create";
        public static final String INDEX = "index";
        public static final String DELETE = "delete";
        public static final String WRITE = "write";
        public static final String MONITOR = "monitor";
        public static final String MANAGE = "manage";
        public static final String DELETE_INDEX = "delete_index";
        public static final String CREATE_INDEX = "create_index";
        public static final String VIEW_INDEX_METADATA = "view_index_metadata";
        public static final String MANAGE_FOLLOW_INDEX = "manage_follow_index";
        public static final String MANAGE_ILM = "manage_ilm";
        public static final String CREATE_DOC = "create_doc";
        public static final String MAINTENANCE = "maintenance";
        public static final String AUTO_CONFIGURE = "auto_configure";
        public static final String[] ALL_ARRAY = new String[] {
            NONE,
            ALL,
            READ,
            READ_CROSS,
            CREATE,
            INDEX,
            DELETE,
            WRITE,
            MONITOR,
            MANAGE,
            DELETE_INDEX,
            CREATE_INDEX,
            VIEW_INDEX_METADATA,
            MANAGE_FOLLOW_INDEX,
            MANAGE_ILM,
            CREATE_DOC,
            MAINTENANCE,
            AUTO_CONFIGURE };
    }

}