org.elasticsearch.cluster.LocalMasterServiceTask Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
There is a newer version: 8.13.4
/*
 * 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.cluster;

import org.elasticsearch.cluster.service.MasterService;
import org.elasticsearch.common.Priority;

import java.util.List;

/**
 * Used to execute things on the master service thread on nodes that are not necessarily master
 */
public abstract class LocalMasterServiceTask implements ClusterStateTaskListener {

    private final Priority priority;

    public LocalMasterServiceTask(Priority priority) {
        this.priority = priority;
    }

    protected void execute(ClusterState currentState) {}

    protected void onPublicationComplete() {}

    public void submit(MasterService masterService, String source) {
        masterService.submitStateUpdateTask(
            source,
            this,
            ClusterStateTaskConfig.build(priority),
            // Uses a new executor each time so that these tasks are not batched, but they never change the cluster state anyway so they
            // don't trigger the publication process and hence batching isn't really needed.
            new ClusterStateTaskExecutor<>() {

                @Override
                public boolean runOnlyOnMaster() {
                    return false;
                }

                @Override
                public String describeTasks(List tasks) {
                    return ""; // only one task in the batch so the source is enough
                }

                @Override
                public ClusterState execute(BatchExecutionContext batchExecutionContext) {
                    final var thisTask = LocalMasterServiceTask.this;
                    final var taskContexts = batchExecutionContext.taskContexts();
                    assert taskContexts.size() == 1 && taskContexts.get(0).getTask() == thisTask
                        : "expected one-element task list containing current object but was " + taskContexts;
                    try (var ignored = taskContexts.get(0).captureResponseHeaders()) {
                        thisTask.execute(batchExecutionContext.initialState());
                    }
                    taskContexts.get(0).success(() -> onPublicationComplete());
                    return batchExecutionContext.initialState();
                }
            }
        );
    }
}