Class BitbucketAuthenticator

    • Field Detail

      • SERVER_URL

        public static final String SERVER_URL
        The key for bitbucket URL as reported in an AuthenticationTokenContext
        See Also:
        Constant Field Values
      • SCHEME

        public static final String SCHEME
        The key for URL scheme as reported in an AuthenticationTokenContext
        See Also:
        Constant Field Values
      • BITBUCKET_INSTANCE_TYPE

        public static final String BITBUCKET_INSTANCE_TYPE
        The key for Bitbucket instance type as reported in an AuthenticationTokenContext
        See Also:
        Constant Field Values
      • BITBUCKET_INSTANCE_TYPE_CLOUD

        public static final String BITBUCKET_INSTANCE_TYPE_CLOUD
        Purpose value for bitbucket cloud (i.e. bitbucket.org)
        See Also:
        Constant Field Values
      • BITBUCKET_INSTANCE_TYPE_SERVER

        public static final String BITBUCKET_INSTANCE_TYPE_SERVER
        Purpose value for bitbucket server
        See Also:
        Constant Field Values
    • Constructor Detail

      • BitbucketAuthenticator

        public BitbucketAuthenticator​(com.cloudbees.plugins.credentials.common.StandardCredentials credentials)
        Constructor
        Parameters:
        credentials - credentials instance this authenticator will use
    • Method Detail

      • getId

        public String getId()
        Returns:
        id of the credentials used.
      • configureBuilder

        public void configureBuilder​(org.apache.http.impl.client.HttpClientBuilder builder)
        Configures an HttpClientBuilder. Override if you need to adjust connection setup.
        Parameters:
        builder - The client builder.
      • configureContext

        public void configureContext​(org.apache.http.client.protocol.HttpClientContext context,
                                     org.apache.http.HttpHost host)
        Configures an HttpClientContext. Override
        Parameters:
        context - The connection context
        host - host being connected to
      • configureRequest

        public void configureRequest​(org.apache.http.HttpRequest request)
        Configures an HttpRequest. Override this if your authentication method needs to set headers on a per-request basis.
        Parameters:
        request - the request.
      • addAuthToken

        public BitbucketHref addAuthToken​(BitbucketHref bitbucketHref)
        Add authentication token to clone link if authentication method requires it
        Returns:
        updated clone link
      • authenticationContext

        public static jenkins.authentication.tokens.api.AuthenticationTokenContext<BitbucketAuthenticator> authenticationContext​(String serverUrl)
        Generates context that sub-classes can use to determine if they would be able to authenticate against the provided server.
        Parameters:
        serverUrl - The URL being authenticated against
        Returns:
        an AuthenticationTokenContext for use with the AuthenticationTokens APIs