Package com.veracode.jenkins.plugin.utils

Class FormValidationUtil

java.lang.Object

com.veracode.jenkins.plugin.utils.FormValidationUtil

public final class FormValidationUtil
extends Object

The FormValidationUtil is a utility class for performing validation of form fields.

Method Summary

Modifier and Type	Method	Description
static FormValidation	checkAnalysisName(String analysisName)	Checks if analysis name is empty.
static FormValidation	checkApiId(String vid, String vkey, boolean hasGlobalApiIdKeyCredentials)	Checks if API ID and dependency fields are entered.
static FormValidation	checkApiKey(String vid, String vkey, boolean hasGlobalApiIdKeyCredentials)	Checks if API Key and dependency fields are entered.
static FormValidation	checkConnection(String id, String key, ProxyBlock proxy)	Determines the result of the form field validation depending on whether a web request to Veracode's getapplist.do's API end point with the supplied credentials and proxy settings is successful.
static FormValidation	checkFields(String fieldValue, String dependencyFieldValue, String fieldDisplayName, String dependencyFieldDisplayName, String dependencyFieldIHelpTextName)	Determines the result of the form field validation depending on whether two form fields have user-supplied data.
static String	checkMaximumDuration(int maximumDuration)	Returns error message if entered value is less than minimum number, or greater than maximum number.
static FormValidation	checkMaximumDuration(String maximumDuration)	Returns error message if entered value is less than minimum number, or greater than maximum number, or not a valid number.
static FormValidation	checkMutuallyInclusiveFields(String fieldValue, String dependencyFieldValue, String fieldDisplayName, String dependencyFieldDisplayName, String dependencyFieldIHelpTextName)	Determines the result of the form field validation depending on whether two mutually inclusive form fields have user-supplied data.
static String	checkWaitForResultsDuration(int waitForResultsDuration)	Returns error message if entered value is less than minimum number, or greater than maximum number.
static FormValidation	checkWaitForResultsDuration(String waitForResultsDuration)	Returns error message if entered value is less than minimum number, or greater than maximum number, or not a valid number.
static String	formatTimeout(String timeoutValue)	Assigns a default timeout value if waitForScan is set to true and no timeout value is entered.

Methods inherited from class java.lang.Object

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

Method Detail

checkMutuallyInclusiveFields

public static FormValidation checkMutuallyInclusiveFields(String fieldValue,
                                                          String dependencyFieldValue,
                                                          String fieldDisplayName,
                                                          String dependencyFieldDisplayName,
                                                          String dependencyFieldIHelpTextName)

Determines the result of the form field validation depending on whether two mutually inclusive form fields have user-supplied data.

Parameters:

fieldValue - a String object.

dependencyFieldValue - a String object.

fieldDisplayName - a String object.

dependencyFieldDisplayName - a String object.

dependencyFieldIHelpTextName - a String object.

Returns:

a FormValidation object.

checkFields

public static FormValidation checkFields(String fieldValue,
                                         String dependencyFieldValue,
                                         String fieldDisplayName,
                                         String dependencyFieldDisplayName,
                                         String dependencyFieldIHelpTextName)

Determines the result of the form field validation depending on whether two form fields have user-supplied data.

Parameters:

fieldValue - a String object.

dependencyFieldValue - a String object.

fieldDisplayName - a String object.

dependencyFieldDisplayName - a String object.

dependencyFieldIHelpTextName - a String object.

Returns:

a FormValidation object.

checkConnection

public static FormValidation checkConnection(String id,
                                             String key,
                                             ProxyBlock proxy)

Determines the result of the form field validation depending on whether a web request to Veracode's getapplist.do's API end point with the supplied credentials and proxy settings is successful.

Parameters:

id - a String object.

key - a String object.

proxy - a ProxyBlock object.

Returns:

a FormValidation object.

checkAnalysisName

public static FormValidation checkAnalysisName(String analysisName)

Checks if analysis name is empty.

Parameters:

analysisName - a String object.

Returns:

a FormValidation object.

checkMaximumDuration

public static FormValidation checkMaximumDuration(String maximumDuration)

Returns error message if entered value is less than minimum number, or greater than maximum number, or not a valid number.

Parameters:

maximumDuration - a String object.

Returns:

a FormValidation object.

checkMaximumDuration

public static String checkMaximumDuration(int maximumDuration)

Returns error message if entered value is less than minimum number, or greater than maximum number.

Parameters:

maximumDuration - a int.

Returns:

a String object.

checkWaitForResultsDuration

public static FormValidation checkWaitForResultsDuration(String waitForResultsDuration)

Returns error message if entered value is less than minimum number, or greater than maximum number, or not a valid number.

Parameters:

waitForResultsDuration - a String object.

Returns:

a FormValidation object.

checkWaitForResultsDuration

public static String checkWaitForResultsDuration(int waitForResultsDuration)

Returns error message if entered value is less than minimum number, or greater than maximum number.

Parameters:

waitForResultsDuration - a int.

Returns:

a String object.

checkApiId

public static FormValidation checkApiId(String vid,
                                        String vkey,
                                        boolean hasGlobalApiIdKeyCredentials)

Checks if API ID and dependency fields are entered.

Parameters:

vid - a String object.

vkey - a String object.

hasGlobalApiIdKeyCredentials - a boolean.

Returns:

a FormValidation object.

checkApiKey

public static FormValidation checkApiKey(String vid,
                                         String vkey,
                                         boolean hasGlobalApiIdKeyCredentials)

Checks if API Key and dependency fields are entered.

Parameters:

vid - a String object.

vkey - a String object.

hasGlobalApiIdKeyCredentials - a boolean.

Returns:

a FormValidation object.

formatTimeout

public static String formatTimeout(String timeoutValue)

Assigns a default timeout value if waitForScan is set to true and no timeout value is entered.

Parameters:

timeoutValue - a String object.

Returns:

a String object.