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

Class DefaultBlackDuckHttpClient

java.lang.Object

com.synopsys.integration.rest.client.IntHttpClient

com.synopsys.integration.rest.client.AuthenticatingIntHttpClient

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

All Implemented Interfaces:

BlackDuckHttpClient

Direct Known Subclasses:

ApiTokenBlackDuckHttpClient, CredentialsBlackDuckHttpClient

public abstract class DefaultBlackDuckHttpClient
extends com.synopsys.integration.rest.client.AuthenticatingIntHttpClient
implements BlackDuckHttpClient

Field Summary

Fields

Modifier and Type	Field	Description
protected com.synopsys.integration.rest.support.AuthenticationSupport	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
DefaultBlackDuckHttpClient(com.synopsys.integration.log.IntLogger logger, int timeout, boolean alwaysTrustServerCertificate, com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo, com.synopsys.integration.rest.HttpUrl baseUrl, UserAgentItem solutionUserAgentItem, UserAgentItem blackDuckCommonUserAgentItem, com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport, com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)
DefaultBlackDuckHttpClient(com.synopsys.integration.log.IntLogger logger, int timeout, boolean alwaysTrustServerCertificate, com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo, com.synopsys.integration.rest.HttpUrl baseUrl, UserAgentItem solutionUserAgentItem, com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport, com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)
DefaultBlackDuckHttpClient(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.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport, com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)

Method Summary

Modifier and Type	Method	Description
protected void	addToHttpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder, org.apache.http.client.config.RequestConfig.Builder defaultRequestConfigBuilder)
com.synopsys.integration.rest.response.Response	execute(com.synopsys.integration.rest.request.Request request)
com.synopsys.integration.rest.HttpUrl	getBaseUrl()
org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder()
java.lang.String	getUserAgentString()
void	handleErrorResponse(org.apache.http.client.methods.HttpUriRequest request, com.synopsys.integration.rest.response.Response response)
boolean	isAlreadyAuthenticated(org.apache.http.client.methods.HttpUriRequest request)
void	throwExceptionForError(com.synopsys.integration.rest.response.Response response)

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

attemptAuthentication, attemptConnection, authenticateRequest, canConnect, completeAuthenticationRequest, 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

attemptAuthentication, executeGetRequestIfModifiedSince, extractErrorResponse, getLogger, getProxyInfo, getTimeoutInSeconds, isAlwaysTrustServerCertificate

Field Detail

authenticationSupport

protected final com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport

Constructor Detail

DefaultBlackDuckHttpClient

public DefaultBlackDuckHttpClient(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.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport,
                                  com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)

DefaultBlackDuckHttpClient

public DefaultBlackDuckHttpClient(com.synopsys.integration.log.IntLogger logger,
                                  int timeout,
                                  boolean alwaysTrustServerCertificate,
                                  com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo,
                                  com.synopsys.integration.rest.HttpUrl baseUrl,
                                  UserAgentItem solutionUserAgentItem,
                                  com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport,
                                  com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)

DefaultBlackDuckHttpClient

public DefaultBlackDuckHttpClient(com.synopsys.integration.log.IntLogger logger,
                                  int timeout,
                                  boolean alwaysTrustServerCertificate,
                                  com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo,
                                  com.synopsys.integration.rest.HttpUrl baseUrl,
                                  UserAgentItem solutionUserAgentItem,
                                  UserAgentItem blackDuckCommonUserAgentItem,
                                  com.synopsys.integration.rest.support.AuthenticationSupport authenticationSupport,
                                  com.synopsys.integration.blackduck.api.generated.discovery.BlackDuckMediaTypeDiscovery blackDuckMediaTypeDiscovery)

Method Detail

execute

public com.synopsys.integration.rest.response.Response execute(com.synopsys.integration.rest.request.Request request)
                                                        throws com.synopsys.integration.exception.IntegrationException

Specified by:

execute in interface BlackDuckHttpClient

Overrides:

execute in class com.synopsys.integration.rest.client.IntHttpClient

Throws:

com.synopsys.integration.exception.IntegrationException

isAlreadyAuthenticated

public boolean isAlreadyAuthenticated(org.apache.http.client.methods.HttpUriRequest request)

Specified by:

isAlreadyAuthenticated in interface BlackDuckHttpClient

Specified by:

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

handleErrorResponse

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

Specified by:

handleErrorResponse in interface BlackDuckHttpClient

Overrides:

handleErrorResponse in class com.synopsys.integration.rest.client.IntHttpClient

throwExceptionForError

public void throwExceptionForError(com.synopsys.integration.rest.response.Response response)
                            throws com.synopsys.integration.exception.IntegrationException

Specified by:

throwExceptionForError in interface BlackDuckHttpClient

Overrides:

throwExceptionForError in class com.synopsys.integration.rest.client.IntHttpClient

Throws:

com.synopsys.integration.exception.IntegrationException

getBaseUrl

public com.synopsys.integration.rest.HttpUrl getBaseUrl()

Specified by:

getBaseUrl in interface BlackDuckHttpClient

getUserAgentString

public java.lang.String getUserAgentString()

Specified by:

getUserAgentString in interface BlackDuckHttpClient

getHttpClientBuilder

public org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder()

Specified by:

getHttpClientBuilder in interface BlackDuckHttpClient

addToHttpClientBuilder

protected void addToHttpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder,
                                      org.apache.http.client.config.RequestConfig.Builder defaultRequestConfigBuilder)

Overrides:

addToHttpClientBuilder in class com.synopsys.integration.rest.client.IntHttpClient