com.axway.apim.lib

Class CommandParameters

java.lang.Object

com.axway.apim.lib.CommandParameters

Direct Known Subclasses:

StandardExportParams

public class CommandParameters
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	APIM_CLI_HOME
static String	MODE_ADD
static String	MODE_IGNORE
static String	MODE_REPLACE

Constructor Summary

Constructors

Constructor and Description
CommandParameters(org.apache.commons.cli.CommandLine cmd)
CommandParameters(org.apache.commons.cli.CommandLine cmd, org.apache.commons.cli.CommandLine internalCmd, EnvironmentProperties environment)
CommandParameters(org.apache.commons.cli.CommandLine cmd, org.apache.commons.cli.CommandLine internalCmd, EnvironmentProperties environment, boolean validateParams)
CommandParameters(Map<String,String> manualParams) Use this constructor manually build a CommandParameters instance.

Method Summary

Modifier and Type	Method and Description
boolean	allowOrgAdminsToPublish()
boolean	changeOrganization()
List<APIManagerAdapter.CacheType>	clearCaches()
String	getAdminPassword()
String	getAdminUsername()
String	getAPIManagerURL()
String	getClientAppsMode()
String	getClientOrgsMode()
String	getConfDir()
String	getDetailsExportFile()
Map<String,String>	getEnvironmentProperties()
String	getHostname()
static CommandParameters	getInstance()
String	getPassword()
int	getPort()
String	getQuotaMode()
String	getUsername()
String	getValue(String key)
boolean	hasOption(String key)
boolean	ignoreAdminAccount()
boolean	ignoreCache()
boolean	isForce()
boolean	isIgnoreClientApps()
boolean	isIgnoreClientOrgs()
boolean	isIgnoreQuotas()
boolean	replaceHostInSwagger()
boolean	rollback()
void	setEnvProperties(EnvironmentProperties envProperties)
void	validateRequiredParameters()

Methods inherited from class java.lang.Object

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

Field Detail

MODE_REPLACE

public static String MODE_REPLACE

MODE_IGNORE

public static String MODE_IGNORE

MODE_ADD

public static String MODE_ADD

APIM_CLI_HOME

public static String APIM_CLI_HOME

Constructor Detail

CommandParameters

public CommandParameters(Map<String,String> manualParams)

Use this constructor manually build a CommandParameters instance. This is useful when calling Swagger-Promote other classes or running tests.

Parameters:

manualParams - to be used for parameter lookup internally

CommandParameters

public CommandParameters(org.apache.commons.cli.CommandLine cmd)
                  throws AppException

Throws:

AppException

CommandParameters

public CommandParameters(org.apache.commons.cli.CommandLine cmd,
                         org.apache.commons.cli.CommandLine internalCmd,
                         EnvironmentProperties environment)
                  throws AppException

Throws:

AppException

CommandParameters

public CommandParameters(org.apache.commons.cli.CommandLine cmd,
                         org.apache.commons.cli.CommandLine internalCmd,
                         EnvironmentProperties environment,
                         boolean validateParams)
                  throws AppException

Throws:

AppException

Method Detail

getInstance

public static CommandParameters getInstance()

getUsername

public String getUsername()

getPassword

public String getPassword()

getAdminUsername

public String getAdminUsername()

getAdminPassword

public String getAdminPassword()

getHostname

public String getHostname()

getPort

public int getPort()

isForce

public boolean isForce()

isIgnoreQuotas

public boolean isIgnoreQuotas()

isIgnoreClientApps

public boolean isIgnoreClientApps()

getQuotaMode

public String getQuotaMode()

getClientAppsMode

public String getClientAppsMode()

isIgnoreClientOrgs

public boolean isIgnoreClientOrgs()

getClientOrgsMode

public String getClientOrgsMode()

getAPIManagerURL

public String getAPIManagerURL()

ignoreAdminAccount

public boolean ignoreAdminAccount()

allowOrgAdminsToPublish

public boolean allowOrgAdminsToPublish()

getDetailsExportFile

public String getDetailsExportFile()

replaceHostInSwagger

public boolean replaceHostInSwagger()

rollback

public boolean rollback()

changeOrganization

public boolean changeOrganization()

getConfDir

public String getConfDir()

ignoreCache

public boolean ignoreCache()

clearCaches

public List<APIManagerAdapter.CacheType> clearCaches()

validateRequiredParameters

public void validateRequiredParameters()
                                throws AppException

Throws:

AppException

hasOption

public boolean hasOption(String key)

getValue

public String getValue(String key)

getEnvironmentProperties

public Map<String,String> getEnvironmentProperties()

setEnvProperties

public void setEnvProperties(EnvironmentProperties envProperties)