oracle.kv.impl.admin.plan.ChangeANParamsPlan Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation
NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.
The newest version!
/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv.impl.admin.plan;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import oracle.kv.impl.admin.IllegalCommandException;
import oracle.kv.impl.admin.param.ArbNodeParams;
import oracle.kv.impl.admin.plan.task.NewArbNodeParameters;
import oracle.kv.impl.admin.plan.task.StartNode;
import oracle.kv.impl.admin.plan.task.StopNode;
import oracle.kv.impl.admin.plan.task.WaitForNodeState;
import oracle.kv.impl.admin.plan.task.WriteNewANParams;
import oracle.kv.impl.param.ParameterMap;
import oracle.kv.impl.param.ParameterUtils;
import oracle.kv.impl.security.KVStorePrivilege;
import oracle.kv.impl.security.SystemPrivilege;
import oracle.kv.impl.topo.ArbNodeId;
import oracle.kv.impl.topo.StorageNodeId;
import oracle.kv.impl.topo.Topology;
import oracle.kv.impl.util.ConfigurableService.ServiceStatus;

public class ChangeANParamsPlan extends AbstractPlan {

    private static final long serialVersionUID = 1L;

    protected ParameterMap newParams;
    public ChangeANParamsPlan(String name,
                              Planner planner,
                              Topology topology,
                              Set anids,
                              ParameterMap map) {

        super(name, planner);

        if (anids.isEmpty()) {
            throw new IllegalCommandException(
                "Cannot change Arbiter parameters because there are " +
                "no arbiter nodes.");
        }

        this.newParams = map;
        /* Do as much error checking as possible, before the plan is executed.*/
        validateParams(newParams);
        
        if (planner.getAdmin().checkAdminGroupVersion(
                WriteNewANParams.WITH_NOTIFY)) {
            generateTasksV2(anids, topology);
        } else {
            generateTasksV1(anids, topology);
        }
    }
    
    private void generateTasksV2(Set anids, Topology topology) {
        for (ArbNodeId anid : anids) {
            StorageNodeId snid = topology.get(anid).getStorageNodeId();
            ParameterMap filtered = newParams.readOnlyFilter();
            addTask(new WriteNewANParams(this, filtered, anid, snid, true));
        }  
    }
    
    private void generateTasksV1(Set anids, Topology topology) {
        Set restartIds = new HashSet();

        /*
         * First write the new params on all nodes.
         */
        for (ArbNodeId anid : anids) {
            StorageNodeId snid = topology.get(anid).getStorageNodeId();
            ParameterMap filtered = newParams.readOnlyFilter();
            addTask(new WriteNewANParams(this, filtered, anid, snid, false));
            ArbNodeParams current = planner.getAdmin().getArbNodeParams(anid);

            /*
             * If restart is required put the Arbiter Node in a new set to be
             * handled below, otherwise, add a task to refresh parameters.
             */
            if (filtered.hasRestartRequiredDiff(current.getMap())) {
                restartIds.add(anid);
            } else {
                addTask(new NewArbNodeParameters(this, anid));
            }
        }

        if (!restartIds.isEmpty()) {
            List restart = sort(restartIds, topology);
            for (ArbNodeId anid : restart) {
                StorageNodeId snid = topology.get(anid).getStorageNodeId();

                addTask(new StopNode(this, snid, anid, false));
                addTask(new StartNode(this, snid, anid, false));
                addTask(new WaitForNodeState(this,
                                             anid,
                                             ServiceStatus.RUNNING));
            }
        }
    }

    protected List sort(Set ids,
    		@SuppressWarnings("unused") Topology topology) {
        List list = new ArrayList();
        for (ArbNodeId id : ids) {
            list.add(id);
        }
        return list;
    }

    protected void validateParams(ParameterMap map) {

        /* Check for incorrect JE params. */
        ParameterUtils.validateArbParams(map);
    }

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

    @Override
    void preExecutionSave() {
       /* Nothing to save before execution. */
    }

    @Override
    public String getDefaultName() {
        return "Change ArbNode Params";
    }

    @Override
    public void stripForDisplay() {
        newParams = null;
    }

    @Override
    public List getRequiredPrivileges() {
        /* Requires SYSOPER */
        return SystemPrivilege.sysoperPrivList;
    }
}