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

Interface BlackDuckHttpClient

All Known Implementing Classes:

ApiTokenBlackDuckHttpClient, CachingHttpClient, CredentialsBlackDuckHttpClient, DefaultBlackDuckHttpClient

public interface BlackDuckHttpClient

Method Summary

Modifier and Type	Method	Description
com.synopsys.integration.rest.response.Response	attemptAuthentication()
com.synopsys.integration.rest.response.Response	execute(com.synopsys.integration.rest.request.Request request)
java.util.Optional<com.synopsys.integration.rest.response.Response>	executeGetRequestIfModifiedSince(com.synopsys.integration.rest.request.Request getRequest, long timeToCheck)
java.util.Optional<com.synopsys.integration.rest.response.ErrorResponse>	extractErrorResponse(java.lang.String responseContent)
com.synopsys.integration.rest.HttpUrl	getBaseUrl()
org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder()
com.synopsys.integration.log.IntLogger	getLogger()
com.synopsys.integration.rest.proxy.ProxyInfo	getProxyInfo()
int	getTimeoutInSeconds()
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)
boolean	isAlwaysTrustServerCertificate()
void	throwExceptionForError(com.synopsys.integration.rest.response.Response response)

Method Detail

execute

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

Throws:

com.synopsys.integration.exception.IntegrationException

executeGetRequestIfModifiedSince

java.util.Optional<com.synopsys.integration.rest.response.Response> executeGetRequestIfModifiedSince(com.synopsys.integration.rest.request.Request getRequest,
                                                                                                     long timeToCheck)
                                                                                              throws com.synopsys.integration.exception.IntegrationException,
                                                                                                     java.io.IOException

Throws:

com.synopsys.integration.exception.IntegrationException

java.io.IOException

attemptAuthentication

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

Throws:

com.synopsys.integration.exception.IntegrationException

isAlreadyAuthenticated

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

extractErrorResponse

java.util.Optional<com.synopsys.integration.rest.response.ErrorResponse> extractErrorResponse(java.lang.String responseContent)

handleErrorResponse

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

throwExceptionForError

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

Throws:

com.synopsys.integration.exception.IntegrationException

getBaseUrl

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

getUserAgentString

java.lang.String getUserAgentString()

getHttpClientBuilder

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

getTimeoutInSeconds

int getTimeoutInSeconds()

isAlwaysTrustServerCertificate

boolean isAlwaysTrustServerCertificate()

getProxyInfo

com.synopsys.integration.rest.proxy.ProxyInfo getProxyInfo()

getLogger

com.synopsys.integration.log.IntLogger getLogger()