org.datadog.jenkins.plugins.datadogbuildreporter

Class DatadogBuildListener.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<DatadogBuildListener>

org.datadog.jenkins.plugins.datadogbuildreporter.DatadogBuildListener.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

DatadogBuildListener

@Extension
public static final class DatadogBuildListener.DescriptorImpl
extends hudson.model.Descriptor<DatadogBuildListener>

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

See DatadogBuildListener/*.jelly for the actual HTML fragment for the configuration screen.

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
DescriptorImpl() Runs when the DatadogBuildListener.DescriptorImpl class is created.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Indicates if this builder can be used with all kinds of project types.
hudson.util.FormValidation	doTestConnection(String formApiKey) Tests the apiKey from the configuration screen, to check its' validity.
hudson.util.Secret	getApiKey() Getter function for the apiKey global configuration.
String	getDisplayName() Getter function for a human readable plugin name, used in the configuration screen.
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass) Indicates if this builder can be used with all kinds of project types.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, 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()

Runs when the DatadogBuildListener.DescriptorImpl class is created.

Method Detail

doTestConnection

public hudson.util.FormValidation doTestConnection(@QueryParameter(value="apiKey")
                                                   String formApiKey)
                                            throws IOException,
                                                   javax.servlet.ServletException

Tests the apiKey from the configuration screen, to check its' validity.

Parameters:

formApiKey - - A String containing the apiKey submitted from the form on the configuration screen, which will be used to authenticate a request to the Datadog API.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

Throws:

IOException - if there is an input/output exception.

javax.servlet.ServletException - if there is a servlet exception.

isApplicable

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

Indicates if this builder can be used with all kinds of project types.

Parameters:

aClass - - An extension of the AbstractProject class representing a specific type of project.

Returns:

a boolean signifying whether or not a builder can be used with a specific type of project.

getDisplayName

public String getDisplayName()

Getter function for a human readable plugin name, used in the configuration screen.

Specified by:

getDisplayName in class hudson.model.Descriptor<DatadogBuildListener>

Returns:

a String containing the human readable display name for this plugin.

configure

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

Indicates if this builder can be used with all kinds of project types.

Overrides:

configure in class hudson.model.Descriptor<DatadogBuildListener>

Parameters:

req - - A StaplerRequest object

formData - - A JSONObject containing the submitted form data from the configuration screen.

Returns:

a boolean signifying the success or failure of configuration.

Throws:

FormException - if the formData is invalid.

hudson.model.Descriptor.FormException

getApiKey

public hudson.util.Secret getApiKey()

Getter function for the apiKey global configuration.

Returns:

a String containing the apiKey global configuration.