nizhikov commented on code in PR #10581: URL: https://github.com/apache/ignite/pull/10581#discussion_r1178115031
########## modules/core/src/main/java/org/apache/ignite/internal/management/api/Command.java: ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.internal.management.api; + +import java.util.Collection; +import java.util.UUID; +import java.util.function.Consumer; +import org.apache.ignite.compute.ComputeTask; +import org.apache.ignite.internal.dto.IgniteDataTransferObject; +import org.apache.ignite.internal.visor.VisorTaskArgument; + +/** + * Management command interface. + * Implementations represents single action to manage Ignite cluster. + * + * Name of the command that is expected from caller derived from actual command class name. + * Name format: all words divided by capital letters except "Command" suffix will form hierarchical command name. + * Example: {@code MyUsefullCommand} is name of command so {@code control.sh --my-usesull param1 param2} expected from user. + * Other protocols must expose command similarly. Rest API must expect {@code /api-root/my-usefull?param1=value1¶m2=value2} URI. + * + * @param <A> Argument type. + * @param <R> Result type. + */ +public interface Command<A extends IgniteDataTransferObject, R> { + /** */ + public String CMD_NAME_POSTFIX = "Command"; + + /** Command description. */ + public String description(); + + /** @return Arguments class. */ + public Class<? extends A> args(); + + /** @return Task class. */ + public Class<? extends ComputeTask<VisorTaskArgument<A>, R>> task(); + + /** + * Prints command result to the user. + * @param arg Argument. + * @param res Result. + * @param printer Implementation specific printer. + */ + public default void printResult(A arg, R res, Consumer<String> printer) { + // No-op. + } + + /** @return {@code true} if the command is experimental, {@code false} otherwise. */ + public default boolean experimental() { + return false; + } + + /** + * @return Message text to show user for. If null it means that confirmantion is not needed. + */ + public default String confirmationPrompt() { + return null; + } + + /** + * @param nodes Live nodes. + * @param arg Argument. + * @return nodes to execute command on, {@code null} means default node must be used. Review Comment: For other invokers default node can be different. JMX will use local node as default. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
