oracle.kv.impl.admin.client.PingCommand 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.client;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.rmi.RemoteException;

import oracle.kv.impl.admin.CommandServiceAPI;
import oracle.kv.impl.admin.param.Parameters;
import oracle.kv.impl.topo.RepGroupId;
import oracle.kv.impl.topo.Topology;
import oracle.kv.impl.util.CommandParser;
import oracle.kv.util.Ping;
import oracle.kv.util.shell.Shell;
import oracle.kv.util.shell.ShellCommand.ShellCommandJsonConvert;
import oracle.kv.util.shell.ShellException;

/*
 * Add flags, trim down output
 */
@POST
class PingCommand extends ShellCommandJsonConvert {

    PingCommand() {
        super("ping", 3);
    }

    @Override
    public String execute(String[] args, Shell shell)
        throws ShellException {
        if (args.length > 3) {
            shell.unknownArgument(args[3], this);
        }
        CommandShell cmd = (CommandShell) shell;
        CommandServiceAPI cs = cmd.getAdmin();
        RepGroupId shard = null;
        try {
            Topology topo = cs.getTopology();
            Parameters params = cs.getParameters();
            ByteArrayOutputStream os = new ByteArrayOutputStream();
            PrintStream ps = new PrintStream(os);

            for (int i = 1; i < args.length; i++) {
                final String arg = args[i];
                if ("-shard".equals(arg)) {
                    shard = RepGroupId.parse(
                                Shell.nextArg(args, i++,this));
                } else {
                    shell.unknownArgument(arg, this);
                }
            }

            if (shard != null) {
                /*
                 * Need to ensure the shard request for status exists in
                 * topology.
                 */
                CommandUtils.ensureShardExists(shard, cs, this);
            }

            final int jsonVersion =
                shell.getJson() ? CommandParser.JSON_V1 : -1;

            Ping.pingTopology(topo, params, false /* showHidden */,
                              jsonVersion, ps, cmd.getLoginManager(),
                              shard);

            return os.toString();
        } catch (RemoteException re) {
            cmd.noAdmin(re);
        }
        return "";
    }

    @Override
    protected String getCommandSyntax() {
        return "ping [-shard rgX] " +
                CommandParser.getJsonUsage();
    }

    @Override
    public String getCommandDescription() {
        return
            "\"Ping\"s the runtime components of a store." +
            eolt + "Components available from the Topology are " +
            "contacted," + eolt + "as well as Admin services.";
    }
}