org.finra.herd.tools.common

Class ToolsArgumentHelper

java.lang.Object

org.finra.herd.tools.common.ToolsArgumentHelper

public class ToolsArgumentHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
ToolsArgumentHelper()

Method Summary

Modifier and Type	Method and Description
static String	getCliEnvArgumentValue(ArgumentParser argParser, org.apache.commons.cli.Option cliOpt, org.apache.commons.cli.Option enableEnvVariablesOpt) Retrieves the user provided password, fetch cli provided password first, otherwise fetch environment provided password if enableEnvVariables option is true
static void	validateCliEnvArgument(ArgumentParser argParser, org.apache.commons.cli.Option cliOpt, org.apache.commons.cli.Option enableEnvVariablesOpt) Validate cli option and env parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToolsArgumentHelper

public ToolsArgumentHelper()

Method Detail

validateCliEnvArgument

public static void validateCliEnvArgument(ArgumentParser argParser,
                                          org.apache.commons.cli.Option cliOpt,
                                          org.apache.commons.cli.Option enableEnvVariablesOpt)
                                   throws org.apache.commons.cli.ParseException

Validate cli option and env parameter

Parameters:

argParser - argument parser instance

cliOpt - cli option

enableEnvVariablesOpt - enableEnvVariables cli option

Throws:

org.apache.commons.cli.ParseException - when neither is provided

getCliEnvArgumentValue

public static String getCliEnvArgumentValue(ArgumentParser argParser,
                                            org.apache.commons.cli.Option cliOpt,
                                            org.apache.commons.cli.Option enableEnvVariablesOpt)
                                     throws org.apache.commons.cli.ParseException

Retrieves the user provided password, fetch cli provided password first, otherwise fetch environment provided password if enableEnvVariables option is true

Parameters:

argParser - argument parser instance

cliOpt - cli option

enableEnvVariablesOpt - enableEnvVariables cli option

Returns:

String for cli provided parameter value or env provided parameter value

Throws:

org.apache.commons.cli.ParseException - if the value of the argument is an invalid boolean value