Package com.cloudbees.jenkins.plugins.bitbucket.endpoints

Class BitbucketCloudEndpoint

java.lang.Object

com.cloudbees.jenkins.plugins.bitbucket.endpoints.AbstractBitbucketEndpoint

com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketCloudEndpoint

All Implemented Interfaces:

BitbucketEndpoint, Describable<BitbucketEndpoint>

public class BitbucketCloudEndpoint
extends AbstractBitbucketEndpoint

Represents Bitbucket Cloud.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BitbucketCloudEndpoint.DescriptorImpl	Our descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVER_URL	The URL of Bitbucket Cloud.

Constructor Summary

Constructors

Constructor	Description
BitbucketCloudEndpoint()	Default constructor.
BitbucketCloudEndpoint(boolean enableCache, int teamCacheDuration, int repositoriesCacheDuration, boolean manageHooks, String credentialsId)	Deprecated.
BitbucketCloudEndpoint(boolean enableCache, int teamCacheDuration, int repositoriesCacheDuration, boolean manageHooks, String credentialsId, boolean enableHookSignature, String hookSignatureCredentialsId)	Constructor.

Method Summary

Modifier and Type	Method	Description
BitbucketEndpointDescriptor	getDescriptor()
String	getDisplayName()	Name to use to describe the endpoint.
int	getRepositoriesCacheDuration()
String	getRepositoryUrl(String repoOwner, String repository)	The user facing URL of the specified repository.
String	getServerUrl()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getServerURL()	The URL of this endpoint.
int	getTeamCacheDuration()
EndpointType	getType()	Returns the type of this endpoint.
boolean	isEnableCache()

Methods inherited from class com.cloudbees.jenkins.plugins.bitbucket.endpoints.AbstractBitbucketEndpoint

authenticator, credentials, getBitbucketJenkinsRootUrl, getCredentialsId, getEndpointJenkinsRootUrl, getEndpointJenkinsRootUrl, getEndpointJenkinsRootURL, getHookSignatureCredentialsId, getRepositoryURL, hookSignatureCredentials, isEnableHookSignature, isManageHooks, setBitbucketJenkinsRootUrl, setManageHooks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.cloudbees.jenkins.plugins.bitbucket.api.endpoint.BitbucketEndpoint

isEquals

Field Details

SERVER_URL

public static final String SERVER_URL

The URL of Bitbucket Cloud.

See Also:

• Constant Field Values

Constructor Details

BitbucketCloudEndpoint

public BitbucketCloudEndpoint()

Default constructor.

BitbucketCloudEndpoint

@Deprecated(since="936.3.1")
public BitbucketCloudEndpoint(boolean enableCache,
 int teamCacheDuration,
 int repositoriesCacheDuration,
 boolean manageHooks,
 @CheckForNull
 String credentialsId)

Deprecated.

BitbucketCloudEndpoint

@DataBoundConstructor
public BitbucketCloudEndpoint(boolean enableCache,
 int teamCacheDuration,
 int repositoriesCacheDuration,
 boolean manageHooks,
 @CheckForNull
 String credentialsId,
 boolean enableHookSignature,
 @CheckForNull
 String hookSignatureCredentialsId)

Constructor.

Parameters:

enableCache - true if caching should be used to reduce requests to Bitbucket.

teamCacheDuration - How long, in minutes, to cache the team response.

repositoriesCacheDuration - How long, in minutes, to cache the repositories response.

manageHooks - true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

credentialsId - The IdCredentials.getId() of the credentials to use for auto-management of hooks.

enableHookSignature - true hooks that comes Bitbucket Data Center are signed.

hookSignatureCredentialsId - The IdCredentials.getId() of the credentials to use for verify the signature of payload.

Method Details

isEnableCache

public boolean isEnableCache()

getTeamCacheDuration

public int getTeamCacheDuration()

getRepositoriesCacheDuration

public int getRepositoriesCacheDuration()

getDisplayName

public String getDisplayName()

Name to use to describe the endpoint.

Returns:

the name to use for the endpoint

getServerUrl

@NonNull
@Deprecated(since="936.4.0",
            forRemoval=true)
public String getServerUrl()

Deprecated, for removal: This API element is subject to removal in a future version.

The URL of this endpoint.

Specified by:

getServerUrl in class AbstractBitbucketEndpoint

Returns:

the URL of the endpoint.

getServerURL

public String getServerURL()

Description copied from interface: BitbucketEndpoint

The URL of this endpoint.

Returns:

the URL of the endpoint.

getRepositoryUrl

@NonNull
public String getRepositoryUrl(@NonNull
 String repoOwner,
 @NonNull
 String repository)

The user facing URL of the specified repository.

Specified by:

getRepositoryUrl in class AbstractBitbucketEndpoint

Parameters:

repoOwner - the repository owner.

repository - the repository.

Returns:

the user facing URL of the specified repository.

getType

public EndpointType getType()

Description copied from interface: BitbucketEndpoint

Returns the type of this endpoint.

Returns:

endpoint type.

getDescriptor

public BitbucketEndpointDescriptor getDescriptor()

Description copied from class: AbstractBitbucketEndpoint

Specified by:

getDescriptor in interface BitbucketEndpoint

Specified by:

getDescriptor in interface Describable<BitbucketEndpoint>

Overrides:

getDescriptor in class AbstractBitbucketEndpoint

See Also:

• Describable.getDescriptor()