Package com.synopsys.integration.blackduck.http.client

Class ApiTokenBlackDuckHttpClient

java.lang.Object

com.synopsys.integration.rest.client.IntHttpClient

com.synopsys.integration.rest.client.AuthenticatingIntHttpClient

com.synopsys.integration.blackduck.http.client.DefaultBlackDuckHttpClient

com.synopsys.integration.blackduck.http.client.ApiTokenBlackDuckHttpClient

All Implemented Interfaces:

BlackDuckHttpClient

public class ApiTokenBlackDuckHttpClient
extends DefaultBlackDuckHttpClient

Connection to the Black Duck application which authenticates using the API token feature

Field Summary

Fields inherited from class com.synopsys.integration.blackduck.http.client.DefaultBlackDuckHttpClient

authenticationSupport

Fields inherited from class com.synopsys.integration.rest.client.IntHttpClient

DEFAULT_TIMEOUT, ERROR_MSG_PROXY_INFO_NULL, logger, SSL_CONTEXT_SUPPLIER

Constructor Summary

Constructors

Constructor

Description

ApiTokenBlackDuckHttpClient(com.synopsys.integration.log.IntLogger logger, int timeout, boolean alwaysTrustServerCertificate, com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo, com.synopsys.integration.rest.HttpUrl baseUrl, com.synopsys.integration.util.NameVersion solutionDetails, com.google.gson.Gson gson, com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport, java.lang.String apiToken, com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)

Method Summary

Modifier and Type	Method	Description
com.synopsys.integration.rest.response.Response	attemptAuthentication()
protected void	completeAuthenticationRequest(org.apache.http.client.methods.HttpUriRequest request, com.synopsys.integration.rest.response.Response response)

Methods inherited from class com.synopsys.integration.blackduck.http.client.DefaultBlackDuckHttpClient

addToHttpClientBuilder, execute, getBaseUrl, getHttpClientBuilder, getUserAgentString, handleErrorResponse, isAlreadyAuthenticated, throwExceptionForError

Methods inherited from class com.synopsys.integration.rest.client.AuthenticatingIntHttpClient

attemptConnection, authenticateRequest, canConnect, execute, execute, isUnauthorizedOrForbidden

Methods inherited from class com.synopsys.integration.rest.client.IntHttpClient

addCommonRequestHeader, addCommonRequestHeaders, createHttpUriRequest, createRequestBuilder, createRequestBuilder, execute, executeGetRequestIfModifiedSince, executeGetRequestIfModifiedSince, extractErrorResponse, getClientBuilder, getCommonRequestHeaders, getCredentialsProvider, getDefaultRequestConfigBuilder, getLogger, getProxyInfo, getTimeoutInSeconds, isAlwaysTrustServerCertificate, logRequestHeaders, logResponseHeaders, removeCommonRequestHeader

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.synopsys.integration.blackduck.http.client.BlackDuckHttpClient

executeGetRequestIfModifiedSince, extractErrorResponse, getLogger, getProxyInfo, getTimeoutInSeconds, isAlwaysTrustServerCertificate

Constructor Detail

ApiTokenBlackDuckHttpClient

public ApiTokenBlackDuckHttpClient(com.synopsys.integration.log.IntLogger logger,
                                   int timeout,
                                   boolean alwaysTrustServerCertificate,
                                   com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo,
                                   com.synopsys.integration.rest.HttpUrl baseUrl,
                                   com.synopsys.integration.util.NameVersion solutionDetails,
                                   com.google.gson.Gson gson,
                                   com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport,
                                   java.lang.String apiToken,
                                   com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)

Method Detail

attemptAuthentication

public final com.synopsys.integration.rest.response.Response attemptAuthentication()
                                                                            throws com.synopsys.integration.exception.IntegrationException

Specified by:

attemptAuthentication in interface BlackDuckHttpClient

Specified by:

attemptAuthentication in class com.synopsys.integration.rest.client.AuthenticatingIntHttpClient

Throws:

com.synopsys.integration.exception.IntegrationException

completeAuthenticationRequest

protected void completeAuthenticationRequest(org.apache.http.client.methods.HttpUriRequest request,
                                             com.synopsys.integration.rest.response.Response response)

Specified by:

completeAuthenticationRequest in class com.synopsys.integration.rest.client.AuthenticatingIntHttpClient