org.jenkinsci.plugins.githubautostatus

Class BuildStatusConfig

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.githubautostatus.BuildStatusConfig

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Extension
public class BuildStatusConfig
extends GlobalConfiguration

Provides configuration options for this plugin.

Author:

Jeff Pearce (jxpearce@godaddy.com)

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

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
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json) Invoked when the global configuration page is submitted
FormValidation	doCheckCredentialsId(Item item, String value) Validates the credentialsId
ListBoxModel	doFillCredentialsIdItems(String credentialsId) Fill the list box in the settings page with valid 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() Get the credentials Id
String	getDisplayName() Gets human readable name
boolean	getEnableGithub() Get a flag indicating whether to enable GitHub.
boolean	getEnableInfluxDb() Get flag determining whether writing to influxdb is enabled
boolean	getEnableStatsd() Get flag determining whether writing to statsd is enabled
String	getInfluxDbDatabase() Get the value of influxDbDatabase
String	getInfluxDbRetentionPolicy() Get the value of influxDbRetentionPolicy
String	getInfluxDbUrl() Get the value of influxDbUrl
String	getStatsdBucket() Get the value of statsdBucket
String	getStatsdHost() Get the value of statsdHost
String	getStatsdMaxSize() Get the value of statsdMaxSize
String	getStatsdPort() Get the value of statsdPort
void	setCredentialsId(String credentialsId) Sets the credentials Id
void	setEnableGithub(boolean enableGithub) Set whether sending status to github is enabled
void	setEnableInfluxDb(boolean enableInfluxDb) Set whether writing to influxdb is enabled
void	setEnableStatsd(boolean enableStatsd) Set whether writing to statsd is enabled
void	setInfluxDbDatabase(String influxDbDatabase) Set the value of influxDbDatabase
void	setInfluxDbRetentionPolicy(String influxDbRetentionPolicy) Set the value of influxDbRetentionPolicy
void	setInfluxDbUrl(String influxDbUrl) Set the value of influxDbUrl
void	setStatsdBucket(String statsdBucket) Set the value of statsdBucket
void	setStatsdHost(String statsdURL) Set the value of statsdHost
void	setStatsdMaxSize(String statsdMaxSize) Set the value of statsdMaxSize
void	setStatsdPort(String statsdPort) Set the value of statsdPort

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

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 Descriptor<GlobalConfiguration>

Returns:

human readable name

configure

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

Invoked when the global configuration page is submitted

Overrides:

configure in class 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:

Descriptor.FormException - exception if a form field is invalid

getEnableGithub

public boolean getEnableGithub()

Get a flag indicating whether to enable GitHub. 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)

Set whether sending status to github is enabled

Parameters:

enableGithub - true to enable sending status to github

getCredentialsId

public String getCredentialsId()

Get the credentials Id

Returns:

the credentials

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

Sets the credentials Id

Parameters:

credentialsId - the credentials Id

getEnableInfluxDb

public boolean getEnableInfluxDb()

Get flag determining whether writing to influxdb is enabled

Returns:

true if writing to influxdb is enabled

setEnableInfluxDb

@DataBoundSetter
public void setEnableInfluxDb(boolean enableInfluxDb)

Set whether writing to influxdb is enabled

Parameters:

enableInfluxDb - true to enable writing to influxdb

getInfluxDbUrl

public String getInfluxDbUrl()

Get the value of influxDbUrl

Returns:

the value of influxDbUrl

setInfluxDbUrl

@DataBoundSetter
public void setInfluxDbUrl(String influxDbUrl)

Set the value of influxDbUrl

Parameters:

influxDbUrl - new value of influxDbUrl

getInfluxDbDatabase

public String getInfluxDbDatabase()

Get the value of influxDbDatabase

Returns:

the value of influxDbDatabase

setInfluxDbDatabase

@DataBoundSetter
public void setInfluxDbDatabase(String influxDbDatabase)

Set the value of influxDbDatabase

Parameters:

influxDbDatabase - new value of influxDbDatabase

getInfluxDbRetentionPolicy

public String getInfluxDbRetentionPolicy()

Get the value of influxDbRetentionPolicy

Returns:

the value of influxDbRetentionPolicy

setInfluxDbRetentionPolicy

@DataBoundSetter
public void setInfluxDbRetentionPolicy(String influxDbRetentionPolicy)

Set the value of influxDbRetentionPolicy

Parameters:

influxDbRetentionPolicy - new value of influxDbRetentionPolicy

getEnableStatsd

public boolean getEnableStatsd()

Get flag determining whether writing to statsd is enabled

Returns:

true if writing to statsd is enabled

setEnableStatsd

@DataBoundSetter
public void setEnableStatsd(boolean enableStatsd)

Set whether writing to statsd is enabled

Parameters:

enableStatsd - true to enable writing to statsd

getStatsdHost

public String getStatsdHost()

Get the value of statsdHost

Returns:

the value of statsdHost

setStatsdHost

@DataBoundSetter
public void setStatsdHost(String statsdURL)

Set the value of statsdHost

Parameters:

statsdURL - new value of statsdHost

getStatsdPort

public String getStatsdPort()

Get the value of statsdPort

Returns:

the value of statsdPort

setStatsdPort

@DataBoundSetter
public void setStatsdPort(String statsdPort)

Set the value of statsdPort

Parameters:

statsdPort - new value of statsdPort

getStatsdBucket

public String getStatsdBucket()

Get the value of statsdBucket

Returns:

the value of statsdBucket

setStatsdBucket

@DataBoundSetter
public void setStatsdBucket(String statsdBucket)

Set the value of statsdBucket

Parameters:

statsdBucket - new value of statsdBucket

getStatsdMaxSize

public String getStatsdMaxSize()

Get the value of statsdMaxSize

Returns:

the value of statsdMaxSize

setStatsdMaxSize

@DataBoundSetter
public void setStatsdMaxSize(String statsdMaxSize)

Set the value of statsdMaxSize

Parameters:

statsdMaxSize - new value of statsdMaxSize

doFillCredentialsIdItems

public ListBoxModel doFillCredentialsIdItems(@QueryParameter
                                             String credentialsId)

Fill the list box in the settings page with valid credentials

Parameters:

credentialsId - the current credentials Id

Returns:

ListBoxModel containing credentials to show

doCheckCredentialsId

public FormValidation doCheckCredentialsId(@AncestorInPath
                                           Item item,
                                           @QueryParameter
                                           String value)

Validates the credentialsId

Parameters:

item - context for validation

value - to validate

Returns:

FormValidation

getCredentials

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