1
0
mirror of https://github.com/google/nomulus synced 2026-01-04 20:24:22 +00:00
Files
nomulus/java/com/google/domain/registry/tools/ConfirmingCommand.java
mcilwain 2293be4079 Automatically create mailing lists for registrars
This improves one of our gTech processes so they no longer have to remember to create Google Groups for a registrar after creating that registrar.

The ConfirmingCommand.verify() method is renamed to be more general purpose, so that it can do anything that follows naturally after a successful execution, such as creating Google Groups groups.

Minor refactoring is done around RegistryToolEnvironment handling for tests to make it more bullet-proof and general case.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=117494277
2016-03-23 22:38:08 -04:00

68 lines
2.1 KiB
Java

// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed 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 com.google.domain.registry.tools;
import static com.google.domain.registry.tools.CommandUtilities.printLineIfNotEmpty;
import static com.google.domain.registry.tools.CommandUtilities.promptForYes;
import com.beust.jcommander.Parameter;
/** A {@link Command} that implements a confirmation step before executing. */
public abstract class ConfirmingCommand implements Command {
@Parameter(
names = {"-f", "--force"},
description = "Do not prompt before executing")
boolean force;
@Override
public final void run() throws Exception {
if (checkExecutionState()) {
init();
printLineIfNotEmpty(prompt());
if (force || promptForYes("Perform this command?")) {
System.out.println(execute());
printLineIfNotEmpty(postExecute());
} else {
System.out.println("Command aborted.");
}
}
}
/** Run any pre-execute command checks and return true if they all pass. */
protected boolean checkExecutionState() throws Exception {
return true;
}
/** Initializes the command. */
protected void init() throws Exception {}
/** Returns the optional extra confirmation prompt for the command. */
protected String prompt() throws Exception {
return "";
}
/** Perform the command and return a result description. */
protected abstract String execute() throws Exception;
/**
* Perform any post-execution steps (e.g. verifying the result), and return a description String
* to be printed if non-empty.
*/
protected String postExecute() throws Exception {
return "";
}
}