Package com.cloudbees.jenkins.plugins.bitbucket.api

Class BitbucketApiFactory

java.lang.Object

com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketApiFactory

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

BitbucketCloudApiFactory, BitbucketServerApiFactory

public abstract class BitbucketApiFactory
extends Object
implements ExtensionPoint

Factory for creating BitbucketApi instances to connect to a given server URL.

Since:

2.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BitbucketApiFactory()

Method Summary

Modifier and Type	Method	Description
protected abstract BitbucketApi	create(String serverURL, BitbucketAuthenticator authenticator, String owner, String projectKey, String repository)	Creates a BitbucketApi for the specified URL with the supplied credentials, owner and (optional) repository.
protected BitbucketApi	create(String serverURL, com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials credentials, String owner, String repository)	Deprecated.
protected abstract boolean	isMatch(String serverUrl)	Tests if the supplied URL is supported by this factory.
static BitbucketApi	newInstance(String serverURL, BitbucketAuthenticator authenticator, String owner, String projectKey, String repository)	Creates a BitbucketApi for the specified URL with the supplied credentials, owner and (optional) repository.

Methods inherited from class java.lang.Object

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

Constructor Details

BitbucketApiFactory

public BitbucketApiFactory()

Method Details

isMatch

protected abstract boolean isMatch(@Nullable
 String serverUrl)

Tests if the supplied URL is supported by this factory.

Parameters:

serverUrl - the server URL (may be null, e.g. for Bitbucket Cloud)

Returns:

true if this factory can connect to the specified URL.

create

@NonNull
protected abstract BitbucketApi create(@Nullable
 String serverURL,
 @Nullable
 BitbucketAuthenticator authenticator,
 @NonNull
 String owner,
 @CheckForNull
 String projectKey,
 @CheckForNull
 String repository)

Creates a BitbucketApi for the specified URL with the supplied credentials, owner and (optional) repository.

Parameters:

serverURL - the server URL.

authenticator - the (optional) authenticator.

owner - the owner name.

projectKey - the (optional) project key.

repository - the (optional) repository name.

Returns:

the BitbucketApi.

create

@NonNull
@Deprecated
protected BitbucketApi create(@Nullable
 String serverURL,
 @Nullable
 com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials credentials,
 @NonNull
 String owner,
 @CheckForNull
 String repository)

Deprecated.

newInstance

@NonNull
public static BitbucketApi newInstance(@Nullable
 String serverURL,
 @Nullable
 BitbucketAuthenticator authenticator,
 @NonNull
 String owner,
 @CheckForNull
 String projectKey,
 @CheckForNull
 String repository)

Creates a BitbucketApi for the specified URL with the supplied credentials, owner and (optional) repository.

Parameters:

serverURL - the server URL.

authenticator - the (optional) authenticator.

owner - the owner name.

projectKey - the (optional) project key.

repository - the (optional) repository name.

Returns:

the BitbucketApi.

Throws:

IllegalArgumentException - if the supplied URL is not supported.