Package io.projectdiscovery.plugins.jenkins.nuclei

Class NucleiBuilder.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Builder>

io.projectdiscovery.plugins.jenkins.nuclei.NucleiBuilder.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

NucleiBuilder

@Extension
public static final class NucleiBuilder.DescriptorImpl
extends BuildStepDescriptor<Builder>

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	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckTargetUrl(String targetUrl, String additionalFlags, String reportingConfiguration, String nucleiVersion)	This method is called by Jenkins to validate the input fields before saving the job's configuration.
ListBoxModel	doFillNucleiVersionItems()	Method called by Jenkins to populate the "Nuclei version" drop-down
String	getDisplayName()
boolean	isApplicable(Class<? extends AbstractProject> aClass)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, 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

DescriptorImpl

public DescriptorImpl()

Method Detail

doCheckTargetUrl

@POST
public FormValidation doCheckTargetUrl(@QueryParameter
                                       String targetUrl,
                                       @QueryParameter
                                       String additionalFlags,
                                       @QueryParameter
                                       String reportingConfiguration,
                                       @QueryParameter
                                       String nucleiVersion)

This method is called by Jenkins to validate the input fields before saving the job's configuration. The name of the method must start with doCheck followed by the name of one of the fields declared in the config.jelly, using standard Java naming conventions and must return FormValidation. The fields intended for validation must match the name of the fields within config.jelly and has to be annotated with QueryParameter.

Parameters:

targetUrl - The URL of the desired application to be tested (mandatory)

additionalFlags - Additional CLI arguments (e.g. -v -debug)

reportingConfiguration - Issue tracker configuration (e.g. Jira/GitHub)

Returns:

FormValidation.ok() or FormValidation.error(java.lang.String) in case of a validation error.

doFillNucleiVersionItems

public ListBoxModel doFillNucleiVersionItems()

Method called by Jenkins to populate the "Nuclei version" drop-down

Returns:

the Nuclei versions retrieved from the GitHub release page in a vX.Y.Z format

isApplicable

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

Specified by:

isApplicable in class BuildStepDescriptor<Builder>

getDisplayName

@Nonnull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Builder>