org.owasp.dependencycheck

Class CliParser

java.lang.Object

org.owasp.dependencycheck.CliParser

public final class CliParser
extends Object

A utility to parse command line arguments for the DependencyCheck.

Author:

Jeremy Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CliParser.ARGUMENT A collection of static final strings that represent the possible command line arguments.

Constructor Summary

Constructors

Constructor and Description
CliParser()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdditionalZipExtensions() Returns the additional Extensions if specified; otherwise null is returned.
String	getApplicationName() Returns the application name specified on the command line.
String	getConnectionString() Returns the database connection string if specified; otherwise null is returned.
String	getConnectionTimeout() Returns the connection timeout.
String	getDatabaseDriverName() Returns the database driver name if specified; otherwise null is returned.
String	getDatabaseDriverPath() Returns the database driver path if specified; otherwise null is returned.
String	getDatabasePassword() Returns the database database password if specified; otherwise null is returned.
String	getDatabaseUser() Returns the database database user name if specified; otherwise null is returned.
String	getDataDirectory() Get the value of dataDirectory.
String[]	getExcludeList() Retrieves the list of excluded file patterns specified by the 'exclude' argument.
String	getNexusUrl() Returns the url to the nexus server if one was specified.
String	getPathToMono() Returns the path to Mono for .NET Assembly analysis on non-windows systems.
File	getPropertiesFile() Returns the properties file specified on the command line.
String	getProxyPassword() Returns the proxy password.
String	getProxyPort() Returns the proxy port.
String	getProxyServer() Returns the proxy server.
String	getProxyUsername() Returns the proxy username.
String	getReportDirectory() Returns the directory to write the reports to specified on the command line.
String	getReportFormat() Returns the output format specified on the command line.
String[]	getScanFiles() Retrieves the file command line parameter(s) specified for the 'scan' argument.
String	getSuppressionFile() Returns the path to the suppression file.
String	getVerboseLog() Returns the path to the verbose log file.
boolean	isArchiveDisabled() Returns true if the disableArchive command line argument was specified.
boolean	isAssemblyDisabled() Returns true if the disableAssembly command line argument was specified.
boolean	isAutoUpdate() Checks if the auto update feature has been disabled.
boolean	isCentralDisabled() Returns true if the disableCentral command line argument was specified.
boolean	isGetHelp() Determines if the 'help' command line argument was passed in.
boolean	isGetVersion() Determines if the 'version' command line argument was passed in.
boolean	isJarDisabled() Returns true if the disableJar command line argument was specified.
boolean	isNexusDisabled() Returns true if the disableNexus command line argument was specified.
boolean	isNexusUsesProxy() Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is returned.
boolean	isNuspecDisabled() Returns true if the disableNuspec command line argument was specified.
boolean	isPythonDistributionDisabled() Returns true if the disablePyDist command line argument was specified.
boolean	isPythonPackageDisabled() Returns true if the disablePyPkg command line argument was specified.
boolean	isRunScan() Determines if the 'scan' command line argument was passed in.
boolean	isUpdateOnly() Checks if the update only flag has been set.
void	parse(String[] args) Parses the arguments passed in and captures the results for later use.
void	printHelp() Displays the command line help message to the standard output.
void	printVersionInfo() Prints the manifest information to standard output.

Methods inherited from class java.lang.Object

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

Constructor Detail

CliParser

public CliParser()

Method Detail

parse

public void parse(String[] args)
           throws FileNotFoundException,
                  org.apache.commons.cli.ParseException

Parses the arguments passed in and captures the results for later use.

Parameters:

args - the command line arguments

Throws:

FileNotFoundException - is thrown when a 'file' argument does not point to a file that exists.

org.apache.commons.cli.ParseException - is thrown when a Parse Exception occurs.

isGetVersion

public boolean isGetVersion()

Determines if the 'version' command line argument was passed in.

Returns:

whether or not the 'version' command line argument was passed in

isGetHelp

public boolean isGetHelp()

Determines if the 'help' command line argument was passed in.

Returns:

whether or not the 'help' command line argument was passed in

isRunScan

public boolean isRunScan()

Determines if the 'scan' command line argument was passed in.

Returns:

whether or not the 'scan' command line argument was passed in

isJarDisabled

public boolean isJarDisabled()

Returns true if the disableJar command line argument was specified.

Returns:

true if the disableJar command line argument was specified; otherwise false

isArchiveDisabled

public boolean isArchiveDisabled()

Returns true if the disableArchive command line argument was specified.

Returns:

true if the disableArchive command line argument was specified; otherwise false

isNuspecDisabled

public boolean isNuspecDisabled()

Returns true if the disableNuspec command line argument was specified.

Returns:

true if the disableNuspec command line argument was specified; otherwise false

isAssemblyDisabled

public boolean isAssemblyDisabled()

Returns true if the disableAssembly command line argument was specified.

Returns:

true if the disableAssembly command line argument was specified; otherwise false

isPythonDistributionDisabled

public boolean isPythonDistributionDisabled()

Returns true if the disablePyDist command line argument was specified.

Returns:

true if the disablePyDist command line argument was specified; otherwise false

isPythonPackageDisabled

public boolean isPythonPackageDisabled()

Returns true if the disablePyPkg command line argument was specified.

Returns:

true if the disablePyPkg command line argument was specified; otherwise false

isNexusDisabled

public boolean isNexusDisabled()

Returns true if the disableNexus command line argument was specified.

Returns:

true if the disableNexus command line argument was specified; otherwise false

isCentralDisabled

public boolean isCentralDisabled()

Returns true if the disableCentral command line argument was specified.

Returns:

true if the disableCentral command line argument was specified; otherwise false

getNexusUrl

public String getNexusUrl()

Returns the url to the nexus server if one was specified.

Returns:

the url to the nexus server; if none was specified this will return null;

isNexusUsesProxy

public boolean isNexusUsesProxy()

Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is returned.

Returns:

true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false

printHelp

public void printHelp()

Displays the command line help message to the standard output.

getScanFiles

public String[] getScanFiles()

Retrieves the file command line parameter(s) specified for the 'scan' argument.

Returns:

the file paths specified on the command line for scan

getExcludeList

public String[] getExcludeList()

Retrieves the list of excluded file patterns specified by the 'exclude' argument.

Returns:

the excluded file patterns

getReportDirectory

public String getReportDirectory()

Returns the directory to write the reports to specified on the command line.

Returns:

the path to the reports directory.

getPathToMono

public String getPathToMono()

Returns the path to Mono for .NET Assembly analysis on non-windows systems.

Returns:

the path to Mono

getReportFormat

public String getReportFormat()

Returns the output format specified on the command line. Defaults to HTML if no format was specified.

Returns:

the output format name.

getApplicationName

public String getApplicationName()

Returns the application name specified on the command line.

Returns:

the application name.

getConnectionTimeout

public String getConnectionTimeout()

Returns the connection timeout.

Returns:

the connection timeout

getProxyServer

public String getProxyServer()

Returns the proxy server.

Returns:

the proxy server

getProxyPort

public String getProxyPort()

Returns the proxy port.

Returns:

the proxy port

getProxyUsername

public String getProxyUsername()

Returns the proxy username.

Returns:

the proxy username

getProxyPassword

public String getProxyPassword()

Returns the proxy password.

Returns:

the proxy password

getDataDirectory

public String getDataDirectory()

Get the value of dataDirectory.

Returns:

the value of dataDirectory

getPropertiesFile

public File getPropertiesFile()

Returns the properties file specified on the command line.

Returns:

the properties file specified on the command line

getVerboseLog

public String getVerboseLog()

Returns the path to the verbose log file.

Returns:

the path to the verbose log file

getSuppressionFile

public String getSuppressionFile()

Returns the path to the suppression file.

Returns:

the path to the suppression file

printVersionInfo

public void printVersionInfo()

Prints the manifest information to standard output.

• Implementation-Title: ${pom.name}
• Implementation-Version: ${pom.version}

isAutoUpdate

public boolean isAutoUpdate()

Checks if the auto update feature has been disabled. If it has been disabled via the command line this will return false.

Returns:

true if auto-update is allowed; otherwise false

isUpdateOnly

public boolean isUpdateOnly()

Checks if the update only flag has been set.

Returns:

true if the update only flag has been set; otherwise false.

getDatabaseDriverName

public String getDatabaseDriverName()

Returns the database driver name if specified; otherwise null is returned.

Returns:

the database driver name if specified; otherwise null is returned

getDatabaseDriverPath

public String getDatabaseDriverPath()

Returns the database driver path if specified; otherwise null is returned.

Returns:

the database driver name if specified; otherwise null is returned

getConnectionString

public String getConnectionString()

Returns the database connection string if specified; otherwise null is returned.

Returns:

the database connection string if specified; otherwise null is returned

getDatabaseUser

public String getDatabaseUser()

Returns the database database user name if specified; otherwise null is returned.

Returns:

the database database user name if specified; otherwise null is returned

getDatabasePassword

public String getDatabasePassword()

Returns the database database password if specified; otherwise null is returned.

Returns:

the database database password if specified; otherwise null is returned

getAdditionalZipExtensions

public String getAdditionalZipExtensions()

Returns the additional Extensions if specified; otherwise null is returned.

Returns:

the additional Extensions; otherwise null is returned