org.elasticsearch.protocol.xpack.XPackInfoRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of x-pack-core Show documentation
Elasticsearch Expanded Pack Plugin - Core
There is a newer version: 8.13.2
/*
 * 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; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */
package org.elasticsearch.protocol.xpack;

import org.elasticsearch.Version;
import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.license.License;
import org.elasticsearch.tasks.TaskId;

import java.io.IOException;
import java.util.EnumSet;
import java.util.Locale;

/**
 * Fetch information about X-Pack from the cluster.
 */
public class XPackInfoRequest extends ActionRequest {

    public enum Category {
        BUILD, LICENSE, FEATURES;

        public static EnumSet toSet(String... categories) {
            EnumSet set = EnumSet.noneOf(Category.class);
            for (String category : categories) {
                switch (category) {
                    case "_all":
                        return EnumSet.allOf(Category.class);
                    case "_none":
                        return EnumSet.noneOf(Category.class);
                    default:
                        set.add(Category.valueOf(category.toUpperCase(Locale.ROOT)));
                }
            }
            return set;
        }
    }

    private boolean verbose;
    private EnumSet categories = EnumSet.noneOf(Category.class);
    private int licenseVersion = License.VERSION_CURRENT;

    public XPackInfoRequest() {
    }

    public XPackInfoRequest(StreamInput in) throws IOException {
        // NOTE: this does *not* call super, THIS IS A BUG that will be fixed in 8.x
        if (in.getVersion().onOrAfter(Version.V_7_12_0)) {
            // The superclass constructor would set the parent task ID, but for now
            // we must serialize and deserialize manually.
            setParentTask(TaskId.readFromStream(in));
        }
        this.verbose = in.readBoolean();
        EnumSet categories = EnumSet.noneOf(Category.class);
        int size = in.readVInt();
        for (int i = 0; i < size; i++) {
            categories.add(Category.valueOf(in.readString()));
        }
        this.categories = categories;
        if (in.getVersion().onOrAfter(Version.V_7_8_1)) {
            this.licenseVersion = in.readVInt();
        }
    }

    public void setVerbose(boolean verbose) {
        this.verbose = verbose;
    }

    public boolean isVerbose() {
        return verbose;
    }

    public void setCategories(EnumSet categories) {
        this.categories = categories;
    }

    public EnumSet getCategories() {
        return categories;
    }

    public int getLicenseVersion() {
        return licenseVersion;
    }

    public void setLicenseVersion(int licenseVersion) {
        this.licenseVersion = licenseVersion;
    }

    @Override
    public ActionRequestValidationException validate() {
        return null;
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        // NOTE: this does *not* call super.writeTo(out), THIS IS A BUG that will be fixed in 8.x
        if (out.getVersion().onOrAfter(Version.V_7_12_0)) {
            getParentTask().writeTo(out);
        }
        out.writeBoolean(verbose);
        out.writeVInt(categories.size());
        for (Category category : categories) {
            out.writeString(category.name());
        }
        if (out.getVersion().onOrAfter(Version.V_7_8_1)) {
            out.writeVInt(this.licenseVersion);
        }
    }
}