maedhroz commented on code in PR #2497: URL: https://github.com/apache/cassandra/pull/2497#discussion_r2232029627
########## src/java/org/apache/cassandra/tools/nodetool/AbstractCommand.java: ########## @@ -0,0 +1,104 @@ +/* + * 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.cassandra.tools.nodetool; + +import javax.inject.Inject; + +import org.apache.cassandra.tools.NodeProbe; +import org.apache.cassandra.tools.Output; + +import picocli.CommandLine; +import picocli.CommandLine.ExecutionException; + +/** + * Abstract class for all nodetool commands, which provides common methods and fields + * for running commands and outputting results. + * <p> + * The command is executed by calling {@link #execute(NodeProbe)}, in all other cases + * it should not contain any fields or methods that are specific to a particular API + * being executed, or common methods that are shared across multiple commands. + * <p> + * Commands must work only with the API provided by the {@link NodeProbe} instance. + */ +public abstract class AbstractCommand implements Runnable +{ + @Inject + protected Output output; + + private NodeProbe probe; + + public void probe(NodeProbe probe) + { + this.probe = probe; + } + + public NodeProbe probe() + { + return probe; + } + + public void logger(Output output) + { + this.output = output; + } + + @Override + public void run() + { + execute(probe()); + } + + /** + * Prepare a command for execution. This method is called before the command is executed and + * can be used to perform any necessary setup or validation. If this method returns {@code false}, + * the command will not initiate connection and will be executed locally. The default implementation + * returns {@code true} so that the command initiates connection to the node before execution. + * + * @return {@code true} if the command is required to connect to the node, {@code false} otherwise. + * @throws ExecutionException if an error occurs during preparation and execution must be aborted. + */ + protected boolean prepareAndConnect() throws ExecutionException Review Comment: ```suggestion protected boolean prepare() throws ExecutionException ``` Do we actually connect to anything? I guess we could also name it like `shouldConnect()` or something, but... -- 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: pr-unsubscr...@cassandra.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For additional commands, e-mail: pr-h...@cassandra.apache.org
