Package org.wildfly.security.tool

Class Command

java.lang.Object
org.wildfly.security.tool.Command
Direct Known Subclasses:
FileSystemRealmIntegrityCommand, VaultCommand
public abstract class Command extends Object
Base command class
Author:
Peter Skopek

  • Field Details

    • GENERAL_CONFIGURATION_ERROR

      public static final int GENERAL_CONFIGURATION_ERROR
      General configuration error exit code.
      See Also:

    • GENERAL_CONFIGURATION_WARNING

      public static final int GENERAL_CONFIGURATION_WARNING
      See Also:

    • INPUT_DATA_NOT_CONFIRMED

      public static final int INPUT_DATA_NOT_CONFIRMED
      See Also:

    • ELYTRON_KS_PASS_PROVIDERS

      public static Supplier<Provider[]> ELYTRON_KS_PASS_PROVIDERS

    • WIDTH

      public static final int WIDTH
      Default help line width.
      See Also:

  • Constructor Details

    • Command

      public Command()

  • Method Details

    • execute

      public abstract void execute(String[] args) throws Exception
      Throws:
      Exception

    • help

      public void help()
      Display help to the command.

    • isAlias

      public boolean isAlias(String alias)

    • aliases

      protected Set<String> aliases()

    • getStatus

      public int getStatus()

    • setStatus

      protected void setStatus(int status)

    • isWindows

      public static boolean isWindows()

    • prompt

      protected String prompt(boolean echo, String prompt, boolean confirm, String confirmPrompt) throws Exception
      Prompt for interactive user input with possible confirmation of input data. When data are not confirmed tool exits with INPUT_DATA_NOT_CONFIRMED exit code
      Parameters:
      echo - echo the characters typed
      prompt - text to display before the input
      confirm - confirm data after the first input
      confirmPrompt - confirmation text
      Returns:
      data as user inputs it
      Throws:
      Exception - if a BufferedReader cannot be created

    • printDuplicatesWarning

      public void printDuplicatesWarning(org.apache.commons.cli.CommandLine cmdLine)
      Alerts if any of the command line options used are duplicated
      Parameters:
      cmdLine - the command line options used when invoking the command, after parsing

    • printDuplicatesWarning

      public void printDuplicatesWarning(org.apache.commons.cli.CommandLine cmdLine, List<String> duplicatesAllowed)
      Alerts if any of the command line options used are duplicated, excluding commands that are allowed to have duplicates
      Parameters:
      cmdLine - the command line options used when invoking the command, after parsing
      duplicatesAllowed - list of the commands line options that can be duplicated. For example: List allowedDuplicates = new ArrayList() {{ add(PASSWORD_CREDENTIAL_VALUE_PARAM); }};

    • warningHandler

      protected void warningHandler(String warning)
      Print a warning message.
      Parameters:
      warning - The warning to be shown

    • errorHandler

      protected void errorHandler(Exception e) throws Exception
      Set an 7 and raise the exception
      Parameters:
      e - The exception thrown during execution
      Throws:
      Exception - The exception to be handled by Elytron Tool

    • isEnableDebug

      public boolean isEnableDebug()
      Get the command debug option

    • setEnableDebug

      public void setEnableDebug(boolean enableDebug)
      Set the command debug option

    • getToolCommand

      public String getToolCommand()
      Get tool command

    • setToolCommand

      public void setToolCommand(String toolCommand)
      Set tool command

    • getProvidersSupplier

      protected Supplier<Provider[]> getProvidersSupplier(String providersList)