001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.cli.processor.command; 028 029import gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext; 030import gov.nist.secauto.metaschema.cli.processor.ExitCode; 031import gov.nist.secauto.metaschema.cli.processor.ExitStatus; 032 033import org.apache.commons.cli.CommandLine; 034 035import java.util.Collection; 036import java.util.Collections; 037import java.util.LinkedHashMap; 038import java.util.Map; 039import java.util.stream.Collectors; 040 041import edu.umd.cs.findbugs.annotations.NonNull; 042 043public abstract class AbstractParentCommand implements ICommand { 044 @NonNull 045 private final Map<String, ICommand> commandToSubcommandHandlerMap; 046 private final boolean subCommandRequired; 047 048 @SuppressWarnings("null") 049 protected AbstractParentCommand(boolean subCommandRequired) { 050 this.commandToSubcommandHandlerMap = Collections.synchronizedMap(new LinkedHashMap<>()); 051 this.subCommandRequired = subCommandRequired; 052 } 053 054 protected void addCommandHandler(ICommand handler) { 055 String commandName = handler.getName(); 056 this.commandToSubcommandHandlerMap.put(commandName, handler); 057 } 058 059 @Override 060 public ICommand getSubCommandByName(String name) { 061 return commandToSubcommandHandlerMap.get(name); 062 } 063 064 @SuppressWarnings("null") 065 @Override 066 public Collection<ICommand> getSubCommands() { 067 return Collections.unmodifiableCollection(commandToSubcommandHandlerMap.values()); 068 } 069 070 @Override 071 public boolean isSubCommandRequired() { 072 return subCommandRequired; 073 } 074 075 @Override 076 public ICommandExecutor newExecutor(CallingContext callingContext, CommandLine cmdLine) { 077 return ICommandExecutor.using(callingContext, cmdLine, this::executeCommand); 078 } 079 080 @NonNull 081 protected ExitStatus executeCommand( 082 @NonNull CallingContext callingContext, 083 @NonNull CommandLine commandLine) { 084 callingContext.showHelp(); 085 ExitStatus status; 086 if (isSubCommandRequired()) { 087 status = ExitCode.INVALID_COMMAND 088 .exitMessage("Please use one of the following sub-commands: " + 089 getSubCommands().stream() 090 .map(command -> command.getName()) 091 .collect(Collectors.joining(", "))); 092 } else { 093 status = ExitCode.OK.exit(); 094 } 095 return status; 096 } 097 098}