Package com.cloudbees.jenkins.plugins.bitbucket.impl.client

Class AbstractBitbucketApi

java.lang.Object
com.cloudbees.jenkins.plugins.bitbucket.impl.client.AbstractBitbucketApi
All Implemented Interfaces:
BitbucketApi, AutoCloseable
Direct Known Subclasses:
BitbucketCloudApiClient, BitbucketServerAPIClient
@Restricted(org.kohsuke.accmod.restrictions.ProtectedExternally.class) public abstract class AbstractBitbucketApi extends Object implements BitbucketApi, AutoCloseable

  • Field Details

    • logger

      protected final Logger logger

  • Constructor Details

  • Method Details

    • buildResponseException

      protected BitbucketRequestException buildResponseException(org.apache.hc.core5.http.ClassicHttpResponse response, String errorMessage)

    • getResponseContent

      protected String getResponseContent(org.apache.hc.core5.http.ClassicHttpResponse response) throws IOException
      Throws:
      IOException

    • connectionManagerBuilder

      protected static org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder connectionManagerBuilder()

    • setupClientBuilder

      protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder setupClientBuilder()

    • setClientProxyParams

      protected void setClientProxyParams(org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)

    • isSupportedAuthenticator

      protected abstract boolean isSupportedAuthenticator(@CheckForNull BitbucketAuthenticator authenticator)
      Implementation must validate if the configured authenticator is supported by this client implementation.

    • getConnectionManager

      @CheckForNull protected abstract org.apache.hc.client5.http.io.HttpClientConnectionManager getConnectionManager()

    • getHost

      @NonNull protected abstract org.apache.hc.core5.http.HttpHost getHost()

    • getBaseURL

      @NonNull protected abstract String getBaseURL()

    • getClient

      @NonNull protected abstract org.apache.hc.client5.http.impl.classic.CloseableHttpClient getClient()

    • executeMethod

      protected org.apache.hc.core5.http.ClassicHttpResponse executeMethod(org.apache.hc.client5.http.classic.methods.HttpUriRequest request) throws IOException
      Throws:
      IOException

    • getRequestAsInputStream

      protected InputStream getRequestAsInputStream(String path) throws IOException
      Throws:
      IOException

    • headRequestStatus

      protected int headRequestStatus(String path) throws IOException
      Throws:
      IOException

    • getRequest

      protected String getRequest(String path) throws IOException
      Throws:
      IOException

    • postRequest

      protected String postRequest(String path, List<? extends org.apache.hc.core5.http.NameValuePair> params) throws IOException
      Throws:
      IOException

    • postRequest

      protected String postRequest(String path, String content) throws IOException
      Throws:
      IOException

    • putRequest

      protected String putRequest(String path, String content) throws IOException
      Throws:
      IOException

    • deleteRequest

      protected String deleteRequest(String path) throws IOException
      Throws:
      IOException

    • close

      public void close() throws IOException
      Description copied from interface: BitbucketApi
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface BitbucketApi
      Throws:
      IOException

    • getAuthenticator

      protected BitbucketAuthenticator getAuthenticator()

    • getWebHooks

      public List<? extends BitbucketWebHook> getWebHooks() throws IOException
      Description copied from interface: BitbucketApi
      Returns the webhooks defined in the repository.
      Specified by:
      getWebHooks in interface BitbucketApi
      Returns:
      the list of webhooks registered in the repository.
      Throws:
      IOException - if there was a network communications error.

    • registerCommitWebHook

      public void registerCommitWebHook(BitbucketWebHook hook) throws IOException
      Description copied from interface: BitbucketApi
      Register a webhook on the repository.
      Specified by:
      registerCommitWebHook in interface BitbucketApi
      Parameters:
      hook - the webhook object
      Throws:
      IOException - if there was a network communications error.

    • updateCommitWebHook

      public void updateCommitWebHook(BitbucketWebHook hook) throws IOException
      Description copied from interface: BitbucketApi
      Update a webhook on the repository.
      Specified by:
      updateCommitWebHook in interface BitbucketApi
      Parameters:
      hook - the webhook object
      Throws:
      IOException - if there was a network communications error.

    • removeCommitWebHook

      public void removeCommitWebHook(BitbucketWebHook hook) throws IOException
      Description copied from interface: BitbucketApi
      Remove the webhook (ID field required) from the repository.
      Specified by:
      removeCommitWebHook in interface BitbucketApi
      Parameters:
      hook - the webhook object
      Throws:
      IOException - if there was a network communications error.

    • adapt

      public <T> T adapt(Class<T> clazz)
      Description copied from interface: BitbucketApi
      Adapt this implementation to the given class.
      Specified by:
      adapt in interface BitbucketApi
      Type Parameters:
      T - the return type
      Parameters:
      clazz - of type T to adapt to
      Returns:
      the adapted class or null if given class is not supported.