com.blackducksoftware.integration.hub.jenkins

Class PostBuildScanDescriptor

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

com.blackducksoftware.integration.hub.jenkins.PostBuildScanDescriptor

All Implemented Interfaces:

hudson.model.Saveable, java.io.Serializable, jenkins.util.io.OnMaster

@Extension(ordinal=2.0)
public class PostBuildScanDescriptor
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
PostBuildScanDescriptor() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.model.AutoCompletionCandidates	doAutoCompleteHubProjectName(java.lang.String hubProjectName)
hudson.util.FormValidation	doCheckBomUpdateMaximumWaitTime(java.lang.String bomUpdateMaximumWaitTime)
hudson.util.FormValidation	doCheckHubProjectName(java.lang.String hubProjectName, java.lang.String hubProjectVersion, boolean dryRun) Performs on-the-fly validation of the form field 'hubProjectName'.
hudson.util.FormValidation	doCheckHubProjectVersion(java.lang.String hubProjectVersion, java.lang.String hubProjectName, boolean dryRun) Performs on-the-fly validation of the form field 'hubProjectVersion'.
hudson.util.FormValidation	doCheckHubServerUrl(java.lang.String hubServerUrl) Performs on-the-fly validation of the form field 'serverUrl'.
hudson.util.FormValidation	doCheckHubTimeout(java.lang.String hubTimeout)
hudson.util.FormValidation	doCheckScanMemory(java.lang.String scanMemory)
void	doConfigDotXml(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Code from https://github.com/jenkinsci/jenkins/blob/master/core/src/main/java/ hudson/model/AbstractItem.java#L602
hudson.util.ListBoxModel	doFillHubCredentialsIdItems() Fills the Credential drop down list in the global config
hudson.util.ListBoxModel	doFillHubVersionDistItems()
hudson.util.ListBoxModel	doFillHubVersionPhaseItems()
hudson.util.FormValidation	doTestConnection(java.lang.String serverUrl, java.lang.String hubCredentialsId, java.lang.String hubTimeout, boolean trustSSLCertificates) Validates that the URL, Username, and Password are correct for connecting to the Hub Server.
java.lang.String	getDefaultProjectName()
java.lang.String	getDefaultProjectVersion()
java.lang.String	getDefaultTimeout() We return a String here instead of an int or Integer because the UI needs a String to display correctly
java.lang.String	getDisplayName() This human readable name is used in the configuration screen.
java.lang.String	getHubCredentialsId()
HubServerInfo	getHubServerInfo()
java.lang.String	getHubServerUrl()
java.lang.String	getHubTimeout() We return a String here instead of an int or Integer because the UI needs a String to display correctly
boolean	getHubWorkspaceCheck()
java.lang.String	getPluginVersion()
boolean	getTrustSSLCertificates()
boolean	isApplicable(java.lang.Class<? extends hudson.model.AbstractProject> aClass)
void	updateByXml(javax.xml.transform.Source source)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

PostBuildScanDescriptor

public PostBuildScanDescriptor()

In order to load the persisted global configuration, you have to call load() in the constructor.

Method Detail

getHubServerInfo

public HubServerInfo getHubServerInfo()

Returns:

the hubServerInfo

getPluginVersion

public java.lang.String getPluginVersion()

getDefaultProjectName

public java.lang.String getDefaultProjectName()

getDefaultProjectVersion

public java.lang.String getDefaultProjectVersion()

doFillHubVersionPhaseItems

public hudson.util.ListBoxModel doFillHubVersionPhaseItems()

doFillHubVersionDistItems

public hudson.util.ListBoxModel doFillHubVersionDistItems()

getHubServerUrl

public java.lang.String getHubServerUrl()

getDefaultTimeout

public java.lang.String getDefaultTimeout()

We return a String here instead of an int or Integer because the UI needs a String to display correctly

getHubTimeout

public java.lang.String getHubTimeout()

We return a String here instead of an int or Integer because the UI needs a String to display correctly

getHubCredentialsId

public java.lang.String getHubCredentialsId()

getTrustSSLCertificates

public boolean getTrustSSLCertificates()

getHubWorkspaceCheck

public boolean getHubWorkspaceCheck()

doConfigDotXml

@WebMethod(name="config.xml")
public void doConfigDotXml(org.kohsuke.stapler.StaplerRequest req,
                                                         org.kohsuke.stapler.StaplerResponse rsp)
                                                  throws java.io.IOException,
                                                         javax.servlet.ServletException,
                                                         javax.xml.parsers.ParserConfigurationException

Code from https://github.com/jenkinsci/jenkins/blob/master/core/src/main/java/ hudson/model/AbstractItem.java#L602

Throws:

java.io.IOException

javax.servlet.ServletException

javax.xml.parsers.ParserConfigurationException

updateByXml

public void updateByXml(javax.xml.transform.Source source)
                 throws java.io.IOException,
                        javax.xml.parsers.ParserConfigurationException

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

isApplicable

public boolean isApplicable(java.lang.Class<? extends hudson.model.AbstractProject> aClass)

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

getDisplayName

public java.lang.String getDisplayName()

This human readable name is used in the configuration screen.

Overrides:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Publisher>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Publisher>

Throws:

hudson.model.Descriptor.FormException

doCheckScanMemory

public hudson.util.FormValidation doCheckScanMemory(@QueryParameter(value="scanMemory")
                                                    java.lang.String scanMemory)
                                             throws java.io.IOException,
                                                    javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckBomUpdateMaximumWaitTime

public hudson.util.FormValidation doCheckBomUpdateMaximumWaitTime(@QueryParameter(value="bomUpdateMaximumWaitTime")
                                                                  java.lang.String bomUpdateMaximumWaitTime)
                                                           throws java.io.IOException,
                                                                  javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

doAutoCompleteHubProjectName

public hudson.model.AutoCompletionCandidates doAutoCompleteHubProjectName(@QueryParameter(value="value")
                                                                          java.lang.String hubProjectName)
                                                                   throws java.io.IOException,
                                                                          javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckHubProjectName

public hudson.util.FormValidation doCheckHubProjectName(@QueryParameter(value="hubProjectName")
                                                        java.lang.String hubProjectName,
                                                        @QueryParameter(value="hubProjectVersion")
                                                        java.lang.String hubProjectVersion,
                                                        @QueryParameter(value="dryRun")
                                                        boolean dryRun)
                                                 throws java.io.IOException,
                                                        javax.servlet.ServletException

Performs on-the-fly validation of the form field 'hubProjectName'. Checks to see if there is already a project in the Hub with this name.

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckHubProjectVersion

public hudson.util.FormValidation doCheckHubProjectVersion(@QueryParameter(value="hubProjectVersion")
                                                           java.lang.String hubProjectVersion,
                                                           @QueryParameter(value="hubProjectName")
                                                           java.lang.String hubProjectName,
                                                           @QueryParameter(value="dryRun")
                                                           boolean dryRun)
                                                    throws java.io.IOException,
                                                           javax.servlet.ServletException

Performs on-the-fly validation of the form field 'hubProjectVersion'. Checks to see if there is already a project in the Hub with this name.

Throws:

java.io.IOException

javax.servlet.ServletException

doFillHubCredentialsIdItems

public hudson.util.ListBoxModel doFillHubCredentialsIdItems()

Fills the Credential drop down list in the global config

Returns:

doCheckHubTimeout

@POST
public hudson.util.FormValidation doCheckHubTimeout(@QueryParameter(value="hubTimeout")
                                                          java.lang.String hubTimeout)
                                                   throws java.io.IOException,
                                                          javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckHubServerUrl

@POST
public hudson.util.FormValidation doCheckHubServerUrl(@QueryParameter(value="hubServerUrl")
                                                            java.lang.String hubServerUrl)
                                                     throws java.io.IOException,
                                                            javax.servlet.ServletException

Performs on-the-fly validation of the form field 'serverUrl'.

Throws:

java.io.IOException

javax.servlet.ServletException

doTestConnection

@POST
public hudson.util.FormValidation doTestConnection(@QueryParameter(value="hubServerUrl")
                                                         java.lang.String serverUrl,
                                                         @QueryParameter(value="hubCredentialsId")
                                                         java.lang.String hubCredentialsId,
                                                         @QueryParameter(value="hubTimeout")
                                                         java.lang.String hubTimeout,
                                                         @QueryParameter(value="trustSSLCertificates")
                                                         boolean trustSSLCertificates)

Validates that the URL, Username, and Password are correct for connecting to the Hub Server.