Package org.jenkinsci.plugins.github_branch_source

Class GitHubSCMNavigator.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<jenkins.scm.api.SCMNavigator>

jenkins.scm.api.SCMNavigatorDescriptor

org.jenkinsci.plugins.github_branch_source.GitHubSCMNavigator.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster, IconSpec

Enclosing class:

GitHubSCMNavigator

@Symbol("github")
@Extension
public static class GitHubSCMNavigator.DescriptorImpl
extends jenkins.scm.api.SCMNavigatorDescriptor
implements IconSpec

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	defaultBuildForkPRHead	Deprecated.
static final boolean	defaultBuildForkPRMerge	Deprecated.
static final boolean	defaultBuildOriginBranch	Deprecated.
static final boolean	defaultBuildOriginBranchWithPR	Deprecated.
static final boolean	defaultBuildOriginPRHead	Deprecated.
static final boolean	defaultBuildOriginPRMerge	Deprecated.
static final String	defaultExcludes	Deprecated.
static final String	defaultIncludes	Deprecated.
static final String	SAME

Fields inherited from class jenkins.scm.api.SCMNavigatorDescriptor

categories

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	Description
protected jenkins.scm.api.SCMSourceCategory[]	createCategories()
FormValidation	doCheckCredentialsId(Item context, String apiUri, String credentialsId, String repoOwner)	Validates the selected credentials.
ListBoxModel	doFillApiUriItems()	Returns the available GitHub endpoint items.
ListBoxModel	doFillCredentialsIdItems(Item context, String apiUri, String credentialsId)	Populates the drop-down list of credentials.
String	getDescription()
String	getDisplayName()
String	getIconClassName()
String	getIconFilePathPattern()
String	getPronoun()
List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>>	getTraitsDefaults()
List<jenkins.scm.impl.form.NamedArrayList<? extends jenkins.scm.api.trait.SCMTraitDescriptor<?>>>	getTraitsDescriptorLists()	Returns the SCMTraitDescriptor instances grouped into categories.
boolean	isApiUriSelectable()	Returns true if there is more than one GitHub endpoint configured, and consequently the UI should provide the ability to select the endpoint.
jenkins.scm.api.SCMNavigator	newInstance(String name)

Methods inherited from class jenkins.scm.api.SCMNavigatorDescriptor

getCategories, getCategoryId

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, 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

Field Details

defaultIncludes

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final String defaultIncludes

Deprecated.

See Also:

• Constant Field Values

defaultExcludes

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final String defaultExcludes

Deprecated.

See Also:

• Constant Field Values

SAME

public static final String SAME

See Also:

• Constant Field Values

defaultBuildOriginBranch

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final boolean defaultBuildOriginBranch

Deprecated.

See Also:

• Constant Field Values

defaultBuildOriginBranchWithPR

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final boolean defaultBuildOriginBranchWithPR

Deprecated.

See Also:

• Constant Field Values

defaultBuildOriginPRMerge

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final boolean defaultBuildOriginPRMerge

Deprecated.

See Also:

• Constant Field Values

defaultBuildOriginPRHead

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final boolean defaultBuildOriginPRHead

Deprecated.

See Also:

• Constant Field Values

defaultBuildForkPRMerge

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final boolean defaultBuildForkPRMerge

Deprecated.

See Also:

• Constant Field Values

defaultBuildForkPRHead

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public static final boolean defaultBuildForkPRHead

Deprecated.

See Also:

• Constant Field Values

Constructor Details

DescriptorImpl

public DescriptorImpl()

Method Details

getPronoun

public String getPronoun()

Overrides:

getPronoun in class jenkins.scm.api.SCMNavigatorDescriptor

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<jenkins.scm.api.SCMNavigator>

getDescription

public String getDescription()

Overrides:

getDescription in class jenkins.scm.api.SCMNavigatorDescriptor

getIconFilePathPattern

public String getIconFilePathPattern()

Overrides:

getIconFilePathPattern in class jenkins.scm.api.SCMNavigatorDescriptor

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

Overrides:

getIconClassName in class jenkins.scm.api.SCMNavigatorDescriptor

newInstance

public jenkins.scm.api.SCMNavigator newInstance(String name)

Overrides:

newInstance in class jenkins.scm.api.SCMNavigatorDescriptor

createCategories

@NonNull
protected jenkins.scm.api.SCMSourceCategory[] createCategories()

Overrides:

createCategories in class jenkins.scm.api.SCMNavigatorDescriptor

doCheckCredentialsId

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public FormValidation doCheckCredentialsId(@CheckForNull @AncestorInPath
 Item context,
 @QueryParameter
 String apiUri,
 @QueryParameter
 String credentialsId,
 @QueryParameter
 String repoOwner)

Validates the selected credentials.

Parameters:

context - the context.

apiUri - the end-point.

credentialsId - the credentials.

Returns:

validation results.

Since:

2.2.0

doFillCredentialsIdItems

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public ListBoxModel doFillCredentialsIdItems(@CheckForNull @AncestorInPath
 Item context,
 @QueryParameter
 String apiUri,
 @QueryParameter
 String credentialsId)

Populates the drop-down list of credentials.

Parameters:

context - the context.

apiUri - the end-point.

credentialsId - the existing selection;

Returns:

the drop-down list.

Since:

2.2.0

doFillApiUriItems

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public ListBoxModel doFillApiUriItems()

Returns the available GitHub endpoint items.

Returns:

the available GitHub endpoint items.

isApiUriSelectable

public boolean isApiUriSelectable()

Returns true if there is more than one GitHub endpoint configured, and consequently the UI should provide the ability to select the endpoint.

Returns:

true if there is more than one GitHub endpoint configured.

getTraitsDescriptorLists

public List<jenkins.scm.impl.form.NamedArrayList<? extends jenkins.scm.api.trait.SCMTraitDescriptor<?>>> getTraitsDescriptorLists()

Returns the SCMTraitDescriptor instances grouped into categories.

Returns:

the categorized list of SCMTraitDescriptor instances.

Since:

2.2.0

getTraitsDefaults

@NonNull
public List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> getTraitsDefaults()

Overrides:

getTraitsDefaults in class jenkins.scm.api.SCMNavigatorDescriptor