Class GitHubPluginConfig
- java.lang.Object
-
- hudson.model.Descriptor<GlobalConfiguration>
-
- jenkins.model.GlobalConfiguration
-
- org.jenkinsci.plugins.github.config.GitHubPluginConfig
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<GlobalConfiguration>
,Saveable
,OnMaster
@Extension public class GitHubPluginConfig extends GlobalConfiguration
Global configuration to store all GH Plugin settings such as hook managing policy, credentials etc.- Since:
- 1.13.0
- Author:
- lanwen (Merkushev Kirill)
-
-
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 Modifier and Type Field Description static GitHubPluginConfig
EMPTY_CONFIG
Helps to avoid null inGitHubPlugin.configuration()
static String
GITHUB_PLUGIN_CONFIGURATION_ID
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Constructor Description GitHubPluginConfig()
GitHubPluginConfig(List<GitHubServerConfig> configs)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description List<Descriptor>
actions()
boolean
configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
FormValidation
doCheckHookUrl(String value)
FormValidation
doReRegister()
Iterable<org.kohsuke.github.GitHub>
findGithubConfig(com.google.common.base.Predicate<GitHubServerConfig> match)
Filters all stored configs against given predicate then logs in as the given user and returns the non null connection objectsprotected XmlFile
getConfigFile()
List<GitHubServerConfig>
getConfigs()
String
getDisplayName()
HookSecretConfig
getHookSecretConfig()
Deprecated.List<HookSecretConfig>
getHookSecretConfigs()
URL
getHookUrl()
String
getId()
To avoid long class name as id in xml tag name and config fileboolean
isManageHooks()
boolean
isOverrideHookUrl()
boolean
isOverrideHookURL()
Deprecated.void
setConfigs(List<GitHubServerConfig> configs)
void
setHookSecretConfig(HookSecretConfig hookSecretConfig)
Deprecated.void
setHookSecretConfigs(List<HookSecretConfig> hookSecretConfigs)
void
setHookUrl(String hookUrl)
void
setOverrideHookUrl(boolean overrideHookUrl)
Deprecated.-
Methods inherited from class jenkins.model.GlobalConfiguration
all, getDescriptor, getGlobalConfigPage
-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
-
-
-
Field Detail
-
GITHUB_PLUGIN_CONFIGURATION_ID
public static final String GITHUB_PLUGIN_CONFIGURATION_ID
- See Also:
- Constant Field Values
-
EMPTY_CONFIG
public static final GitHubPluginConfig EMPTY_CONFIG
Helps to avoid null inGitHubPlugin.configuration()
-
-
Constructor Detail
-
GitHubPluginConfig
public GitHubPluginConfig()
-
GitHubPluginConfig
public GitHubPluginConfig(List<GitHubServerConfig> configs)
-
-
Method Detail
-
setConfigs
@DataBoundSetter public void setConfigs(List<GitHubServerConfig> configs)
-
getConfigs
public List<GitHubServerConfig> getConfigs()
-
isManageHooks
public boolean isManageHooks()
-
setHookUrl
@DataBoundSetter public void setHookUrl(String hookUrl)
-
setOverrideHookUrl
@DataBoundSetter @Deprecated public void setOverrideHookUrl(boolean overrideHookUrl)
Deprecated.
-
getHookUrl
public URL getHookUrl() throws GHPluginConfigException
- Returns:
- hook url used as endpoint to search and write auto-managed hooks in GH
- Throws:
GHPluginConfigException
- if default jenkins url is malformed
-
isOverrideHookUrl
public boolean isOverrideHookUrl()
-
isOverrideHookURL
@Deprecated public boolean isOverrideHookURL()
Deprecated.
-
findGithubConfig
public Iterable<org.kohsuke.github.GitHub> findGithubConfig(com.google.common.base.Predicate<GitHubServerConfig> match)
Filters all stored configs against given predicate then logs in as the given user and returns the non null connection objects
-
actions
public List<Descriptor> actions()
-
getId
public String getId()
To avoid long class name as id in xml tag name and config file- Overrides:
getId
in classDescriptor<GlobalConfiguration>
-
getConfigFile
protected XmlFile getConfigFile()
- Overrides:
getConfigFile
in classDescriptor<GlobalConfiguration>
- Returns:
- config file with global
XStream
instance with enabled aliases inMigrator.enableAliases()
-
configure
public boolean configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json) throws Descriptor.FormException
- Overrides:
configure
in classGlobalConfiguration
- Throws:
Descriptor.FormException
-
getDisplayName
public String getDisplayName()
- Overrides:
getDisplayName
in classDescriptor<GlobalConfiguration>
-
doReRegister
public FormValidation doReRegister()
-
doCheckHookUrl
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public FormValidation doCheckHookUrl(@QueryParameter String value)
-
getHookSecretConfig
@Deprecated public HookSecretConfig getHookSecretConfig()
Deprecated.
-
setHookSecretConfig
@Deprecated public void setHookSecretConfig(HookSecretConfig hookSecretConfig)
Deprecated.
-
getHookSecretConfigs
public List<HookSecretConfig> getHookSecretConfigs()
-
setHookSecretConfigs
@DataBoundSetter public void setHookSecretConfigs(List<HookSecretConfig> hookSecretConfigs)
-
-