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

Class BitbucketServerEndpoint

java.lang.Object

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

com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketServerEndpoint

All Implemented Interfaces:

BitbucketEndpoint, Describable<BitbucketEndpoint>

public class BitbucketServerEndpoint
extends AbstractBitbucketEndpoint

Represents a Bitbucket Server instance.

Since:

2.2.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
BitbucketServerEndpoint(String displayName, String serverUrl, boolean manageHooks, String credentialsId)	Deprecated.
BitbucketServerEndpoint(String displayName, String serverUrl, boolean manageHooks, String credentialsId, boolean enableHookSignature, String hookSignatureCredentialsId)	Constructor.

Method Summary

Modifier and Type	Method	Description
static BitbucketServerVersion	findServerVersion(String serverURL)
static BitbucketServerWebhookImplementation	findWebhookImplementation(String serverURL)
BitbucketEndpointDescriptor	getDescriptor()
String	getDisplayName()	Name to use to describe the endpoint.
String	getRepositoryUrl(String repoOwner, String repository)	The user facing URL of the specified repository.
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.
BitbucketServerVersion	getServerVersion()
EndpointType	getType()	Returns the type of this endpoint.
BitbucketServerWebhookImplementation	getWebhookImplementation()
boolean	isCallCanMerge()
boolean	isCallChanges()
void	setCallCanMerge(boolean callCanMerge)
void	setCallChanges(boolean callChanges)
void	setServerVersion(BitbucketServerVersion serverVersion)
void	setWebhookImplementation(BitbucketServerWebhookImplementation webhookImplementation)

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

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

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

Constructor Details

BitbucketServerEndpoint

@Deprecated(since="936.3.1")
public BitbucketServerEndpoint(@CheckForNull
 String displayName,
 @NonNull
 String serverUrl,
 boolean manageHooks,
 @CheckForNull
 String credentialsId)

Deprecated.

BitbucketServerEndpoint

@DataBoundConstructor
public BitbucketServerEndpoint(@CheckForNull
 String displayName,
 @NonNull
 String serverUrl,
 boolean manageHooks,
 @CheckForNull
 String credentialsId,
 boolean enableHookSignature,
 @CheckForNull
 String hookSignatureCredentialsId)

Constructor.

Parameters:

displayName - Optional name to use to describe the end-point.

serverUrl - The URL of this Bitbucket Server

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

findWebhookImplementation

@NonNull
public static BitbucketServerWebhookImplementation findWebhookImplementation(String serverURL)

findServerVersion

@NonNull
public static BitbucketServerVersion findServerVersion(String serverURL)

isCallCanMerge

public boolean isCallCanMerge()

getType

@NonNull
public EndpointType getType()

Description copied from interface: BitbucketEndpoint

Returns the type of this endpoint.

Returns:

endpoint type.

setCallCanMerge

@DataBoundSetter
public void setCallCanMerge(boolean callCanMerge)

isCallChanges

public boolean isCallChanges()

setCallChanges

@DataBoundSetter
public void setCallChanges(boolean callChanges)

getServerVersion

@NonNull
public BitbucketServerVersion getServerVersion()

setServerVersion

@DataBoundSetter
public void setServerVersion(@NonNull
 BitbucketServerVersion serverVersion)

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.

getRepositoryURL

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

The user facing URL of the specified repository.

Specified by:

getRepositoryURL in interface BitbucketEndpoint

Overrides:

getRepositoryURL in class AbstractBitbucketEndpoint

Parameters:

repoOwner - the repository owner.

repository - the repository name

Returns:

the user facing URL of the specified repository.

getWebhookImplementation

@NonNull
public BitbucketServerWebhookImplementation getWebhookImplementation()

setWebhookImplementation

@DataBoundSetter
public void setWebhookImplementation(@NonNull
 BitbucketServerWebhookImplementation webhookImplementation)

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