name.mlopatkin.bitbucket.api

Class Bitbucket

java.lang.Object

name.mlopatkin.bitbucket.api.Bitbucket

All Implemented Interfaces:

java.lang.AutoCloseable

public class Bitbucket
extends java.lang.Object
implements java.lang.AutoCloseable

Main entry point for the Bitbucket API.

This class allocates resources to serve network requests and therefore has to be explicitly closed when not needed. Note that doing so will invalidate all objects retrieved via this class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_ENDPOINT Default Bitbucket's API endpoint

Constructor Summary

Constructors

Constructor and Description
Bitbucket(RequestAuthenticator authenticator) Constructs an instance of Bitbucket API Facade with a given authenticator.
Bitbucket(RequestAuthenticator authenticator, java.lang.String apiEndpoint) Constructs an instance of Bitbucket API Facade with a given authenticator and a specified API endpoint.

Method Summary

Modifier and Type	Method and Description
void	close()
Repository	getRepository(java.lang.String username, java.lang.String repositoryName) Creates a handle object to access a repository on Bitbucket.

Methods inherited from class java.lang.Object

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

Field Detail

API_ENDPOINT

public static final java.lang.String API_ENDPOINT

Default Bitbucket's API endpoint

See Also:

Constant Field Values

Constructor Detail

Bitbucket

public Bitbucket(RequestAuthenticator authenticator)

Constructs an instance of Bitbucket API Facade with a given authenticator. The authenticator is used to sign requests.

Parameters:

authenticator - the authenticator

Bitbucket

public Bitbucket(RequestAuthenticator authenticator,
                 java.lang.String apiEndpoint)

Constructs an instance of Bitbucket API Facade with a given authenticator and a specified API endpoint. The authenticator is used to sign requests. The provided API endpoint overrides default Bitbucket's API url (https://api.bitbucket.org/2.0/). This constructor can be used for functional testing with test servers or for proxying requests.

Parameters:

authenticator - the authenticator

apiEndpoint - the API endpoint URL

Method Detail

getRepository

public Repository getRepository(java.lang.String username,
                                java.lang.String repositoryName)

Creates a handle object to access a repository on Bitbucket. Note that a valid Repository object will be returned even if the repository with this username/repositoryName doesn't exists on Bitbucket or authenticated account has no access to it. In such case most methods of the returned objects will result in exception.

Parameters:

username - the username/teamname of the owner

repositoryName - the name of the repository

Returns:

the repository object

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable