org.jenkinsci.plugins.DependencyTrack

Class DependencyTrackPublisher.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Publisher>

org.jenkinsci.plugins.DependencyTrack.DependencyTrackPublisher.DescriptorImpl

All Implemented Interfaces:

Saveable, Serializable, OnMaster

Enclosing class:

DependencyTrackPublisher

@Extension
 @Symbol(value="dependencyTrackPublisher")
public static final class DependencyTrackPublisher.DescriptorImpl
extends BuildStepDescriptor<Publisher>
implements Serializable

Descriptor for DependencyTrackPublisher. Used as a singleton. The class is marked as public so that it can be accessed from views.

See src/main/resources/org/jenkinsci/plugins/DependencyCheck/DependencyTrackBuilder/*.jelly for the actual HTML fragment for the configuration screen.

See Also:

Serialized Form

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, 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
DescriptorImpl() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Takes the /apply/save step in the global config and saves the JSON data.
FormValidation	doCheckDependencyTrackUrl(String value) Performs input validation when submitting the global config
ListBoxModel	doFillProjectIdItems() Retrieve the projects to populate the dropdown.
FormValidation	doTestConnection(String dependencyTrackUrl, String dependencyTrackApiKey) Performs an on-the-fly check of the Dependency-Track URL and api key parameters by making a simple call to the server and validating the response code.
String	getDependencyTrackApiKey()
int	getDependencyTrackPollingTimeout()
String	getDependencyTrackUrl()
String	getDisplayName() This name is used on the build configuration screen.
boolean	isApplicable(Class<? extends AbstractProject> aClass)
boolean	isDependencyTrackAutoCreateProjects()
void	setDependencyTrackApiKey(String dependencyTrackApiKey)
void	setDependencyTrackAutoCreateProjects(boolean dependencyTrackAutoCreateProjects)
void	setDependencyTrackPollingTimeout(int dependencyTrackPollingTimeout)
void	setDependencyTrackUrl(String dependencyTrackUrl)

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, getRequiredGlobalConfigPagePermission, 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

DescriptorImpl

public DescriptorImpl()

Default constructor. Obtains the Descriptor used in DependencyCheckBuilder as this contains the global Dependency-Check Jenkins plugin configuration.

Method Detail

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> aClass)

Specified by:

isApplicable in class BuildStepDescriptor<Publisher>

doFillProjectIdItems

public ListBoxModel doFillProjectIdItems()

Retrieve the projects to populate the dropdown.

Returns:

ListBoxModel

doCheckDependencyTrackUrl

public FormValidation doCheckDependencyTrackUrl(@QueryParameter
                                                String value)

Performs input validation when submitting the global config

Parameters:

value - The value of the URL as specified in the global config

Returns:

a FormValidation object

doTestConnection

public FormValidation doTestConnection(@QueryParameter
                                       String dependencyTrackUrl,
                                       @QueryParameter
                                       String dependencyTrackApiKey)

Performs an on-the-fly check of the Dependency-Track URL and api key parameters by making a simple call to the server and validating the response code.

Parameters:

dependencyTrackUrl - the base URL to Dependency-Track

dependencyTrackApiKey - the API key to use for authentication

Returns:

FormValidation

configure

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

Takes the /apply/save step in the global config and saves the JSON data.

Overrides:

configure in class Descriptor<Publisher>

Parameters:

req - the request

formData - the form data

Returns:

a boolean

Throws:

FormException - an exception validating form input

Descriptor.FormException

setDependencyTrackUrl

@DataBoundSetter
public void setDependencyTrackUrl(String dependencyTrackUrl)

setDependencyTrackApiKey

@DataBoundSetter
public void setDependencyTrackApiKey(String dependencyTrackApiKey)

setDependencyTrackAutoCreateProjects

@DataBoundSetter
public void setDependencyTrackAutoCreateProjects(boolean dependencyTrackAutoCreateProjects)

setDependencyTrackPollingTimeout

@DataBoundSetter
public void setDependencyTrackPollingTimeout(int dependencyTrackPollingTimeout)

getDisplayName

public String getDisplayName()

This name is used on the build configuration screen.

Overrides:

getDisplayName in class Descriptor<Publisher>

getDependencyTrackUrl

public String getDependencyTrackUrl()

Returns:

global configuration for dependencyTrackUrl

getDependencyTrackApiKey

public String getDependencyTrackApiKey()

Returns:

global configuration for dependencyTrackApiKey.

isDependencyTrackAutoCreateProjects

public boolean isDependencyTrackAutoCreateProjects()

Returns:

the global configuration for dependencyTrackAutoCreateProjects.

getDependencyTrackPollingTimeout

public int getDependencyTrackPollingTimeout()

Returns:

global configuration for dependencyTrackPollingTimeout.