Package com.synopsys.integration.rest.client

Class AuthenticatingIntHttpClient

java.lang.Object

com.synopsys.integration.rest.client.IntHttpClient

com.synopsys.integration.rest.client.AuthenticatingIntHttpClient

Direct Known Subclasses:

BasicAuthHttpClient

public abstract class AuthenticatingIntHttpClient
extends IntHttpClient

Field Summary

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
AuthenticatingIntHttpClient(com.synopsys.integration.log.IntLogger logger, int timeoutInSeconds, boolean alwaysTrustServerCertificate, ProxyInfo proxyInfo)
AuthenticatingIntHttpClient(com.synopsys.integration.log.IntLogger logger, int timeoutInSeconds, boolean alwaysTrustServerCertificate, ProxyInfo proxyInfo, org.apache.http.client.CredentialsProvider credentialsProvider, org.apache.http.impl.client.HttpClientBuilder clientBuilder, org.apache.http.client.config.RequestConfig.Builder defaultRequestConfigBuilder, java.util.Map<java.lang.String,java.lang.String> commonRequestHeaders)

Method Summary

Modifier and Type	Method	Description
abstract Response	attemptAuthentication()
ConnectionResult	attemptConnection()
void	authenticateRequest(org.apache.http.client.methods.HttpUriRequest request)
boolean	canConnect()
protected abstract void	completeAuthenticationRequest(org.apache.http.client.methods.HttpUriRequest request, Response response)
Response	execute(org.apache.http.client.methods.HttpUriRequest request)
Response	execute(org.apache.http.client.methods.HttpUriRequest request, org.apache.http.protocol.HttpContext httpContext)
abstract boolean	isAlreadyAuthenticated(org.apache.http.client.methods.HttpUriRequest request)
boolean	isUnauthorizedOrForbidden(Response response)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatingIntHttpClient

public AuthenticatingIntHttpClient(com.synopsys.integration.log.IntLogger logger,
                                   int timeoutInSeconds,
                                   boolean alwaysTrustServerCertificate,
                                   ProxyInfo proxyInfo)

AuthenticatingIntHttpClient

public AuthenticatingIntHttpClient(com.synopsys.integration.log.IntLogger logger,
                                   int timeoutInSeconds,
                                   boolean alwaysTrustServerCertificate,
                                   ProxyInfo proxyInfo,
                                   org.apache.http.client.CredentialsProvider credentialsProvider,
                                   org.apache.http.impl.client.HttpClientBuilder clientBuilder,
                                   org.apache.http.client.config.RequestConfig.Builder defaultRequestConfigBuilder,
                                   java.util.Map<java.lang.String,java.lang.String> commonRequestHeaders)

Method Detail

isAlreadyAuthenticated

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

attemptAuthentication

public abstract Response attemptAuthentication()
                                        throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

authenticateRequest

public final void authenticateRequest(org.apache.http.client.methods.HttpUriRequest request)
                               throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException

execute

public Response execute(org.apache.http.client.methods.HttpUriRequest request)
                 throws com.synopsys.integration.exception.IntegrationException

Overrides:

execute in class IntHttpClient

Throws:

com.synopsys.integration.exception.IntegrationException

execute

public Response execute(org.apache.http.client.methods.HttpUriRequest request,
                        org.apache.http.protocol.HttpContext httpContext)
                 throws com.synopsys.integration.exception.IntegrationException

Overrides:

execute in class IntHttpClient

Throws:

com.synopsys.integration.exception.IntegrationException

isUnauthorizedOrForbidden

public final boolean isUnauthorizedOrForbidden(Response response)

canConnect

public boolean canConnect()

attemptConnection

public ConnectionResult attemptConnection()

completeAuthenticationRequest

protected abstract void completeAuthenticationRequest(org.apache.http.client.methods.HttpUriRequest request,
                                                      Response response)
                                               throws com.synopsys.integration.exception.IntegrationException

Throws:

com.synopsys.integration.exception.IntegrationException