Package org.jenkinsci.plugins.github_branch_source

Class GitHubConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.github_branch_source.GitHubConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
public class GitHubConfiguration
extends GlobalConfiguration

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

Method Summary

Modifier and Type	Method	Description
boolean	addEndpoint(Endpoint endpoint)	Adds an endpoint.
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)
ListBoxModel	doFillApiRateLimitCheckerItems()
Endpoint	findEndpoint(String apiUri)	Checks to see if the supplied server URL is defined in the global configuration.
static GitHubConfiguration	get()
ApiRateLimitChecker	getApiRateLimitChecker()
List<Endpoint>	getEndpoints()
Permission	getRequiredGlobalConfigPagePermission()
static String	normalizeApiUri(String apiUri)	Fix an apiUri.
boolean	removeEndpoint(String apiUri)	Removes an endpoint.
boolean	removeEndpoint(Endpoint endpoint)	Removes an endpoint.
void	setApiRateLimitChecker(ApiRateLimitChecker apiRateLimitChecker)
void	setEndpoints(List<Endpoint> endpoints)
void	updateEndpoint(Endpoint endpoint)	Updates an existing endpoint (or adds if missing).

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

GitHubConfiguration

public GitHubConfiguration()

Method Details

get

public static GitHubConfiguration get()

configure

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

Overrides:

configure in class GlobalConfiguration

Throws:

Descriptor.FormException

getEndpoints

@NonNull
public List<Endpoint> getEndpoints()

getApiRateLimitChecker

@NonNull
public ApiRateLimitChecker getApiRateLimitChecker()

setApiRateLimitChecker

public void setApiRateLimitChecker(@CheckForNull
 ApiRateLimitChecker apiRateLimitChecker)

normalizeApiUri

@CheckForNull
public static String normalizeApiUri(@CheckForNull
 String apiUri)

Fix an apiUri.

Parameters:

apiUri - the api URI.

Returns:

the normalized api URI.

setEndpoints

public void setEndpoints(@CheckForNull
 List<Endpoint> endpoints)

addEndpoint

public boolean addEndpoint(@NonNull
 Endpoint endpoint)

Adds an endpoint.

Parameters:

endpoint - the endpoint to add.

Returns:

true if the list of endpoints was modified

updateEndpoint

public void updateEndpoint(@NonNull
 Endpoint endpoint)

Updates an existing endpoint (or adds if missing).

Parameters:

endpoint - the endpoint to update.

removeEndpoint

public boolean removeEndpoint(@NonNull
 Endpoint endpoint)

Removes an endpoint.

Parameters:

endpoint - the endpoint to remove.

Returns:

true if the list of endpoints was modified

removeEndpoint

public boolean removeEndpoint(@CheckForNull
 String apiUri)

Removes an endpoint.

Parameters:

apiUri - the API URI to remove.

Returns:

true if the list of endpoints was modified

findEndpoint

@CheckForNull
public Endpoint findEndpoint(@CheckForNull
 String apiUri)

Checks to see if the supplied server URL is defined in the global configuration.

Parameters:

apiUri - the server url to check.

Returns:

the global configuration for the specified server url or null if not defined.

doFillApiRateLimitCheckerItems

public ListBoxModel doFillApiRateLimitCheckerItems()

getRequiredGlobalConfigPagePermission

@NonNull
public Permission getRequiredGlobalConfigPagePermission()

Overrides:

getRequiredGlobalConfigPagePermission in class Descriptor<GlobalConfiguration>