Class BitbucketSCMSource
java.lang.Object
hudson.model.AbstractDescribableImpl<jenkins.scm.api.SCMSource>
jenkins.scm.api.SCMSource
com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource
- All Implemented Interfaces:
ExtensionPoint
,Describable<jenkins.scm.api.SCMSource>
public class BitbucketSCMSource
extends jenkins.scm.api.SCMSource
SCM source implementation for Bitbucket.
It provides a way to discover/retrieve branches and pull requests through the Bitbucket REST API
which is much faster than the plain Git SCM source implementation.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class jenkins.scm.api.SCMSource
jenkins.scm.api.SCMSource.SourceByItem
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Field Summary
Fields inherited from class jenkins.scm.api.SCMSource
PRONOUN
-
Constructor Summary
ConstructorsConstructorDescriptionBitbucketSCMSource
(String repoOwner, String repository) Constructor.BitbucketSCMSource
(String id, String repoOwner, String repository) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
build
(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMRevision revision) buildBitbucketClient
(String repoOwner, String repository) static int
Returns how long to delay events received from Bitbucket in order to allow the API caches to sync.protected String
List<jenkins.scm.api.trait.SCMSourceTrait>
jenkins.scm.api.SCMRevision
getTrustedRevision
(jenkins.scm.api.SCMRevision revision, TaskListener listener) boolean
isCloud()
Deprecated, for removal: This API element is subject to removal in a future version.jenkins.scm.api.SCMHeadOrigin
protected jenkins.scm.api.SCMRevision
retrieve
(jenkins.scm.api.SCMHead head, TaskListener listener) protected void
retrieve
(jenkins.scm.api.SCMSourceCriteria criteria, jenkins.scm.api.SCMHeadObserver observer, jenkins.scm.api.SCMHeadEvent<?> event, TaskListener listener) retrieveActions
(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMHeadEvent event, TaskListener listener) retrieveActions
(jenkins.scm.api.SCMSourceEvent event, TaskListener listener) void
setCredentialsId
(String credentialsId) static void
setEventDelaySeconds
(int eventDelaySeconds) Sets how long to delay events received from Bitbucket in order to allow the API caches to sync.void
setMirrorId
(String mirrorId) void
setServerUrl
(String serverUrl) void
Methods inherited from class jenkins.scm.api.SCMSource
build, canProbe, checkInterrupt, createProbe, defaultListener, equals, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetchActions, fetchActions, fetchActions, fetchRevisions, fetchRevisions, fromSCMFileSystem, getCategories, getCriteria, getId, getOwner, getPronoun, hashCode, hasId, isCategoryEnabled, newProbe, parentHeads, parentRevisions, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveActions, retrieveRevisions, retrieveRevisions, setId, setOwner, toString, withId
-
Constructor Details
-
BitbucketSCMSource
@DataBoundConstructor public BitbucketSCMSource(@NonNull String repoOwner, @NonNull String repository) Constructor.- Parameters:
repoOwner
- the repository owner.repository
- the repository name.- Since:
- 2.2.0
-
BitbucketSCMSource
@Deprecated public BitbucketSCMSource(@CheckForNull String id, @NonNull String repoOwner, @NonNull String repository) Deprecated.useBitbucketSCMSource(String, String)
andSCMSource.setId(String)
Legacy Constructor.- Parameters:
id
- the id.repoOwner
- the repository owner.repository
- the repository name.
-
-
Method Details
-
getCredentialsId
-
setCredentialsId
-
getMirrorId
-
setMirrorId
-
getRepoOwner
-
getRepository
-
getServerUrl
-
setServerUrl
-
getEndpointJenkinsRootURL
-
getTraits
- Overrides:
getTraits
in classjenkins.scm.api.SCMSource
-
setTraits
@DataBoundSetter public void setTraits(@CheckForNull List<jenkins.scm.api.trait.SCMSourceTrait> traits) - Overrides:
setTraits
in classjenkins.scm.api.SCMSource
-
buildBitbucketClient
-
buildBitbucketClient
-
buildBitbucketClient
-
afterSave
public void afterSave()- Overrides:
afterSave
in classjenkins.scm.api.SCMSource
-
retrieve
protected void retrieve(@CheckForNull jenkins.scm.api.SCMSourceCriteria criteria, @NonNull jenkins.scm.api.SCMHeadObserver observer, @CheckForNull jenkins.scm.api.SCMHeadEvent<?> event, @NonNull TaskListener listener) throws IOException, InterruptedException - Specified by:
retrieve
in classjenkins.scm.api.SCMSource
- Throws:
IOException
InterruptedException
-
retrieve
protected jenkins.scm.api.SCMRevision retrieve(jenkins.scm.api.SCMHead head, TaskListener listener) throws IOException, InterruptedException - Overrides:
retrieve
in classjenkins.scm.api.SCMSource
- Throws:
IOException
InterruptedException
-
build
public SCM build(@NonNull jenkins.scm.api.SCMHead head, @CheckForNull jenkins.scm.api.SCMRevision revision) - Specified by:
build
in classjenkins.scm.api.SCMSource
-
getProjectKey
@CheckForNull @Restricted(org.kohsuke.accmod.restrictions.ProtectedExternally.class) protected String getProjectKey() -
getTrustedRevision
@NonNull public jenkins.scm.api.SCMRevision getTrustedRevision(@NonNull jenkins.scm.api.SCMRevision revision, @NonNull TaskListener listener) throws IOException, InterruptedException - Overrides:
getTrustedRevision
in classjenkins.scm.api.SCMSource
- Throws:
IOException
InterruptedException
-
getDescriptor
- Specified by:
getDescriptor
in interfaceDescribable<jenkins.scm.api.SCMSource>
- Overrides:
getDescriptor
in classjenkins.scm.api.SCMSource
-
retrieveActions
@NonNull protected List<Action> retrieveActions(@CheckForNull jenkins.scm.api.SCMSourceEvent event, @NonNull TaskListener listener) throws IOException, InterruptedException - Overrides:
retrieveActions
in classjenkins.scm.api.SCMSource
- Throws:
IOException
InterruptedException
-
retrieveActions
@NonNull protected List<Action> retrieveActions(@NonNull jenkins.scm.api.SCMHead head, @CheckForNull jenkins.scm.api.SCMHeadEvent event, @NonNull TaskListener listener) throws IOException, InterruptedException - Overrides:
retrieveActions
in classjenkins.scm.api.SCMSource
- Throws:
IOException
InterruptedException
-
originOf
-
getEventDelaySeconds
public static int getEventDelaySeconds()Returns how long to delay events received from Bitbucket in order to allow the API caches to sync.- Returns:
- how long to delay events received from Bitbucket in order to allow the API caches to sync.
-
setEventDelaySeconds
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static void setEventDelaySeconds(int eventDelaySeconds) Sets how long to delay events received from Bitbucket in order to allow the API caches to sync.- Parameters:
eventDelaySeconds
- number of seconds to delay, will be restricted into a value within the range[0,300]
inclusive
-
isCloud
Deprecated, for removal: This API element is subject to removal in a future version.
-
BitbucketSCMSource(String, String)
andSCMSource.setId(String)