org.jenkinsci.plugins.githubautostatus

Class BuildStatusConfig

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.githubautostatus.BuildStatusConfig

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable, jenkins.util.io.OnMaster

@Extension
public class BuildStatusConfig
extends jenkins.model.GlobalConfiguration

Provides configuration options for this plugin.

Author:

Jeff Pearce (GitHub jeffpearce)

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
BuildStatusConfig() Default constructor - loads the configuration

Method Summary

Modifier and Type	Method and Description
static void	addCompatibilityAliases() Adds compatibility aliases to prevent "old data" warnings.
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json) Invoked when the global configuration page is submitted
hudson.util.FormValidation	doCheckCredentialsId(hudson.model.Item item, String value) Validates the credentials id.
hudson.util.FormValidation	doCheckHttpCredentialsId(hudson.model.Item item, String value) Validates the HTTP credentials id.
hudson.util.FormValidation	doCheckHttpEndpoint(hudson.model.Item item, String value)
hudson.util.ListBoxModel	doFillCredentialsIdItems(String credentialsId) Fills the list box in the settings page with valid credentials.
hudson.util.ListBoxModel	doFillDbVersionItems() Fills the list box in the settings page with valid database versions.
hudson.util.ListBoxModel	doFillHttpCredentialsIdItems(String credentialsId) Fills the list box in the settings page with valid HTTP credentials.
static BuildStatusConfig	get() Convenience method to get the configuration object
static <T extends com.cloudbees.plugins.credentials.Credentials> T	getCredentials(Class<T> type, String credentialsId)
String	getCredentialsId() Gets the credentials id.
Integer	getDbVersion() Gets the InfluxDB database version.
String	getDisplayName() Gets human readable name.
boolean	getEnableGithub() Gets whether sending status to GitHub is enabled.
boolean	getEnableHttp() Gets whether sending status to HTTP endpoint is enabled.
boolean	getEnableInfluxDb() Gets whether writing to InfluxDB is enabled.
boolean	getEnableStatsd() Gets whether writing to StatsD is enabled.
String	getHttpCredentialsId() Gets the HTTP credentials id.
String	getHttpEndpoint() Gets the HTTP endpoint URL.
boolean	getHttpVerifySSL() Gets whether SSL verify is enabled.
boolean	getIgnoreSendingTestCoverageToInflux() Gets whether to ignore sending test coverage.
boolean	getIgnoreSendingTestResultsToInflux() Gets whether to ignore sending test results.
String	getInfluxDbDatabase() Gets the InfluxDB database.
String	getInfluxDbRetentionPolicy() Gets the InfluxDB retention policy.
String	getInfluxDbUrl() Gets the InfluxDB URL.
String	getStatsdBucket() Gets the StatsD bucket.
String	getStatsdHost() Gets the StatsD host.
String	getStatsdMaxSize() Gets the StatsD maximum packet size.
String	getStatsdPort() Gets the StatsD port.
void	setCredentialsId(String credentialsId) Sets the credentials id.
void	setDbVersion(Integer dbVersion)
void	setDbVersion(String dbVersion) Sets the InfluxDB database version.
void	setEnableGithub(boolean enableGithub) Sets whether sending status to GitHub is enabled.
void	setEnableHttp(boolean enableHttp) Sets whether sending status to HTTP endpoint is enabled.
void	setEnableInfluxDb(boolean enableInfluxDb) Sets whether writing to InfluxDB is enabled.
void	setEnableStatsd(boolean enableStatsd) Sets whether writing to StatsD is enabled.
void	setHttpCredentialsId(String httpCredentialsId) Sets the HTTP credentials id.
void	setHttpEndpoint(String httpEndpoint) Sets the HTTP endpoint URL.
void	setHttpVerifySSL(boolean httpVerifySSL) Sets whether SSL verify is enabled.
void	setIgnoreSendingTestCoverageToInflux(boolean ignoreSendingTestCoverageToInflux) Sets whether to ignore sending test results.
void	setIgnoreSendingTestResultsToInflux(boolean ignoreSendingTestResultsToInflux) 2ets whether to ignore sending test results.
void	setInfluxDbDatabase(String influxDbDatabase) Sets the InfluxDB database.
void	setInfluxDbRetentionPolicy(String influxDbRetentionPolicy) Sets the InfluxDB retention policy.
void	setInfluxDbUrl(String influxDbUrl) Sets the InfluxDB URL.
void	setStatsdBucket(String statsdBucket) Sets the StatsD bucket.
void	setStatsdHost(String statsdHost) Sets the StatsD host.
void	setStatsdMaxSize(String statsdMaxSize) Sets the StatsD maximum packet size.
void	setStatsdPort(String statsdPort) Sets the StatsD port.

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, 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

BuildStatusConfig

public BuildStatusConfig()

Default constructor - loads the configuration

Method Detail

addCompatibilityAliases

@Initializer(before=PLUGINS_STARTED)
public static void addCompatibilityAliases()

Adds compatibility aliases to prevent "old data" warnings.

get

public static BuildStatusConfig get()

Convenience method to get the configuration object

Returns:

the configuration object

getDisplayName

public String getDisplayName()

Gets human readable name.

Overrides:

getDisplayName in class hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

Returns:

human readable name

configure

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

Invoked when the global configuration page is submitted

Overrides:

configure in class jenkins.model.GlobalConfiguration

Parameters:

req - Request that represents the form submission

json - The JSON object that captures the configuration data

Returns:

always returns true (allow config page to be closed)

Throws:

hudson.model.Descriptor.FormException - exception if a form field is invalid

getEnableGithub

public boolean getEnableGithub()

Gets whether sending status to GitHub is enabled. For compatibility reasons the flag is stored as the inverse (disableGithub) so that GitHub is enabled by default for users who upgrade from a version prior to the flag.

Returns:

true if writing to GitHub is enabled

setEnableGithub

@DataBoundSetter
public void setEnableGithub(boolean enableGithub)

Sets whether sending status to GitHub is enabled.

Parameters:

enableGithub - true to enable sending status to GitHub

getEnableHttp

public boolean getEnableHttp()

Gets whether sending status to HTTP endpoint is enabled.

Returns:

true if writing to HTTP is enabled

setEnableHttp

@DataBoundSetter
public void setEnableHttp(boolean enableHttp)

Sets whether sending status to HTTP endpoint is enabled.

Parameters:

enableHttp - true to enable sending status to HTTP endpoint

getHttpVerifySSL

public boolean getHttpVerifySSL()

Gets whether SSL verify is enabled.

Returns:

true if verify SSL is enabled

setHttpVerifySSL

@DataBoundSetter
public void setHttpVerifySSL(boolean httpVerifySSL)

Sets whether SSL verify is enabled.

Parameters:

httpVerifySSL - true to verify SSL

getCredentialsId

public String getCredentialsId()

Gets the credentials id.

Returns:

the credentials id

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

Sets the credentials id.

Parameters:

credentialsId - the credentials id

getHttpCredentialsId

public String getHttpCredentialsId()

Gets the HTTP credentials id.

Returns:

the credentials id

setHttpCredentialsId

@DataBoundSetter
public void setHttpCredentialsId(String httpCredentialsId)

Sets the HTTP credentials id.

Parameters:

httpCredentialsId - the credentials id

getHttpEndpoint

public String getHttpEndpoint()

Gets the HTTP endpoint URL.

Returns:

the endpoint URL

setHttpEndpoint

@DataBoundSetter
public void setHttpEndpoint(String httpEndpoint)

Sets the HTTP endpoint URL.

Parameters:

httpEndpoint - the endpoint URL

getEnableInfluxDb

public boolean getEnableInfluxDb()

Gets whether writing to InfluxDB is enabled.

Returns:

true if writing to InfluxDB is enabled

setEnableInfluxDb

@DataBoundSetter
public void setEnableInfluxDb(boolean enableInfluxDb)

Sets whether writing to InfluxDB is enabled.

Parameters:

enableInfluxDb - true to enable writing to InfluxDB

getInfluxDbUrl

public String getInfluxDbUrl()

Gets the InfluxDB URL.

Returns:

the URL

setInfluxDbUrl

@DataBoundSetter
public void setInfluxDbUrl(String influxDbUrl)

Sets the InfluxDB URL.

Parameters:

influxDbUrl - the URL

getInfluxDbDatabase

public String getInfluxDbDatabase()

Gets the InfluxDB database.

Returns:

the database

setInfluxDbDatabase

@DataBoundSetter
public void setInfluxDbDatabase(String influxDbDatabase)

Sets the InfluxDB database.

Parameters:

influxDbDatabase - the database

getIgnoreSendingTestResultsToInflux

public boolean getIgnoreSendingTestResultsToInflux()

Gets whether to ignore sending test results.

Returns:

whether to ignore sending test results

setIgnoreSendingTestResultsToInflux

@DataBoundSetter
public void setIgnoreSendingTestResultsToInflux(boolean ignoreSendingTestResultsToInflux)

2ets whether to ignore sending test results.

Parameters:

ignoreSendingTestResultsToInflux - whether to ignore sending test results

getIgnoreSendingTestCoverageToInflux

public boolean getIgnoreSendingTestCoverageToInflux()

Gets whether to ignore sending test coverage.

Returns:

whether to ignore sending test coverage

setIgnoreSendingTestCoverageToInflux

@DataBoundSetter
public void setIgnoreSendingTestCoverageToInflux(boolean ignoreSendingTestCoverageToInflux)

Sets whether to ignore sending test results.

Parameters:

ignoreSendingTestCoverageToInflux - whether to ignore sending test results

getInfluxDbRetentionPolicy

public String getInfluxDbRetentionPolicy()

Gets the InfluxDB retention policy.

Returns:

the retention policy

setInfluxDbRetentionPolicy

@DataBoundSetter
public void setInfluxDbRetentionPolicy(String influxDbRetentionPolicy)

Sets the InfluxDB retention policy.

Parameters:

influxDbRetentionPolicy - the retention policy

getDbVersion

public Integer getDbVersion()

Gets the InfluxDB database version.

Returns:

the database version

setDbVersion

@DataBoundSetter
public void setDbVersion(String dbVersion)

Sets the InfluxDB database version.

Parameters:

dbVersion - the database version

setDbVersion

@DataBoundSetter
public void setDbVersion(Integer dbVersion)

doFillDbVersionItems

public hudson.util.ListBoxModel doFillDbVersionItems()

Fills the list box in the settings page with valid database versions.

getEnableStatsd

public boolean getEnableStatsd()

Gets whether writing to StatsD is enabled.

Returns:

true if writing to StatsD is enabled

setEnableStatsd

@DataBoundSetter
public void setEnableStatsd(boolean enableStatsd)

Sets whether writing to StatsD is enabled.

Parameters:

enableStatsd - true to enable writing to StatsD

getStatsdHost

public String getStatsdHost()

Gets the StatsD host.

Returns:

the host

setStatsdHost

@DataBoundSetter
public void setStatsdHost(String statsdHost)

Sets the StatsD host.

Parameters:

statsdHost - the host

getStatsdPort

public String getStatsdPort()

Gets the StatsD port.

Returns:

the port

setStatsdPort

@DataBoundSetter
public void setStatsdPort(String statsdPort)

Sets the StatsD port.

Parameters:

statsdPort - the port

getStatsdBucket

public String getStatsdBucket()

Gets the StatsD bucket.

Returns:

the bucket

setStatsdBucket

@DataBoundSetter
public void setStatsdBucket(String statsdBucket)

Sets the StatsD bucket.

Parameters:

statsdBucket - the bucket

getStatsdMaxSize

public String getStatsdMaxSize()

Gets the StatsD maximum packet size.

Returns:

the maximum packet size

setStatsdMaxSize

@DataBoundSetter
public void setStatsdMaxSize(String statsdMaxSize)

Sets the StatsD maximum packet size.

Parameters:

statsdMaxSize - the maximum packet size

doFillCredentialsIdItems

public hudson.util.ListBoxModel doFillCredentialsIdItems(@QueryParameter
                                                         String credentialsId)

Fills the list box in the settings page with valid credentials.

Parameters:

credentialsId - the current credentials id

Returns:

ListBoxModel containing credentials to show

doFillHttpCredentialsIdItems

public hudson.util.ListBoxModel doFillHttpCredentialsIdItems(@QueryParameter
                                                             String credentialsId)

Fills the list box in the settings page with valid HTTP credentials.

Parameters:

credentialsId - the current credentials id

Returns:

ListBoxModel containing credentials to show

doCheckCredentialsId

public hudson.util.FormValidation doCheckCredentialsId(@AncestorInPath
                                                       hudson.model.Item item,
                                                       @QueryParameter
                                                       String value)

Validates the credentials id.

Parameters:

item - context for validation

value - to validate

Returns:

FormValidation

doCheckHttpCredentialsId

public hudson.util.FormValidation doCheckHttpCredentialsId(@AncestorInPath
                                                           hudson.model.Item item,
                                                           @QueryParameter
                                                           String value)

Validates the HTTP credentials id.

Parameters:

item - context for validation

value - to validate

Returns:

FormValidation

doCheckHttpEndpoint

public hudson.util.FormValidation doCheckHttpEndpoint(@AncestorInPath
                                                      hudson.model.Item item,
                                                      @QueryParameter
                                                      String value)

getCredentials

public static <T extends com.cloudbees.plugins.credentials.Credentials> T getCredentials(@Nonnull
                                                                                         Class<T> type,
                                                                                         @Nonnull
                                                                                         String credentialsId)