oracle.kv.impl.admin.plan.StopRepNodesPlan 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.

There is a newer version: 18.3.10

/*-
 * 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.List;
import java.util.Set;

import oracle.kv.impl.admin.IllegalCommandException;
import oracle.kv.impl.admin.plan.task.StopNode;
import oracle.kv.impl.security.KVStorePrivilege;
import oracle.kv.impl.security.SystemPrivilege;
import oracle.kv.impl.topo.RepNode;
import oracle.kv.impl.topo.RepNodeId;
import oracle.kv.impl.topo.Topology;

import com.sleepycat.persist.model.Persistent;

/**
 * Stop the given set of RepNodes.
 */
@Persistent
public class StopRepNodesPlan extends AbstractPlan {

    private static final long serialVersionUID = 1L;

    private Set repNodeIds;

    StopRepNodesPlan(String name,
                     Planner planner,
                     Topology topology,
                     Set rnids) {
        super(name, planner);
        repNodeIds = rnids;

        for (RepNodeId rnid : rnids) {
            RepNode rn = topology.get(rnid);

            if (rn == null) {
                throw new IllegalCommandException
                    ("There is no RepNode with id " + rnid +
                     ". Please provide the id of an existing RepNode.");
            }

            addTask(new StopNode(this, rn.getStorageNodeId(),
                                 rnid, true));
        }
    }

    protected StopRepNodesPlan() {
    }

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

    public Set getRepNodeIds() {
       return repNodeIds;
    }

    @Override
    void preExecutionSave() {

        /* Nothing to save in advance. */
    }

    @Override
    public String getDefaultName() {
        return "Stop RepNodes";
    }

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

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