net.snowflake.client.core

Class HttpUtil

java.lang.Object

net.snowflake.client.core.HttpUtil

public class HttpUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpUtil.HttpInputStream

Field Summary

Fields

Modifier and Type	Field and Description
static String	JDBC_TTL

Constructor Summary

Constructors

Constructor and Description
HttpUtil()

Method Summary

Modifier and Type	Method and Description
static void	closeExpiredAndIdleConnections()
static void	configureCustomProxyProperties(Map<SFSessionProperty,Object> connectionPropertiesMap) configure custom proxy properties from connectionPropertiesMap
static String	executeGeneralRequest(org.apache.http.client.methods.HttpRequestBase httpRequest, int retryTimeout, OCSPMode ocspMode) Executes a HTTP request for Snowflake.
static String	executeRequest(org.apache.http.client.methods.HttpRequestBase httpRequest, int retryTimeout, int injectSocketTimeout, AtomicBoolean canceling, boolean includeRetryParameters, boolean retryOnHTTP403, OCSPMode ocspMode) Executes a HTTP request for Snowflake.
static org.apache.http.client.config.RequestConfig	getDefaultRequestConfigWithSocketTimeout(int soTimeoutMs, boolean withoutCookies) Return a request configuration inheriting from the default request configuration of the shared HttpClient with a different socket timeout.
static long	getDownloadedConditionTimeoutInSeconds()
static org.apache.http.impl.client.CloseableHttpClient	getHttpClient(OCSPMode ocspMode) Gets HttpClient with insecureMode false
static org.apache.http.impl.client.CloseableHttpClient	getHttpClientWithoutDecompression(OCSPMode ocspMode) Gets HttpClient with insecureMode false and disabling decompression
static org.apache.http.client.config.RequestConfig	getRequestConfigWithoutCookies() Return a request configuration inheriting from the default request configuration of the shared HttpClient with the coopkie spec set to ignore.
static org.apache.http.impl.client.CloseableHttpClient	initHttpClient(OCSPMode ocspMode, File ocspCacheFile) Accessor for the HTTP client singleton.
static org.apache.http.impl.client.CloseableHttpClient	initHttpClientWithoutDecompression(OCSPMode ocspMode, File ocspCacheFile) Accessor for the HTTP client singleton.
static boolean	isSocksProxyDisabled() Returns whether the SOCKS proxy is disabled for this JVM
static void	setProxyForAzure(com.microsoft.azure.storage.OperationContext opContext)
static void	setProxyForS3(com.amazonaws.ClientConfiguration clientConfig)
static void	setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)
static void	setSocksProxyDisabled(boolean socksProxyDisabled) Enables/disables use of the SOCKS proxy when creating sockets

Methods inherited from class java.lang.Object

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

Field Detail

JDBC_TTL

public static final String JDBC_TTL

See Also:

Constant Field Values

Constructor Detail

HttpUtil

public HttpUtil()

Method Detail

getDownloadedConditionTimeoutInSeconds

public static long getDownloadedConditionTimeoutInSeconds()

closeExpiredAndIdleConnections

public static void closeExpiredAndIdleConnections()

setProxyForS3

public static void setProxyForS3(com.amazonaws.ClientConfiguration clientConfig)

setProxyForAzure

public static void setProxyForAzure(com.microsoft.azure.storage.OperationContext opContext)

getHttpClient

public static org.apache.http.impl.client.CloseableHttpClient getHttpClient(OCSPMode ocspMode)

Gets HttpClient with insecureMode false

Parameters:

ocspMode - OCSP mode

Returns:

HttpClient object shared across all connections

getHttpClientWithoutDecompression

public static org.apache.http.impl.client.CloseableHttpClient getHttpClientWithoutDecompression(OCSPMode ocspMode)

Gets HttpClient with insecureMode false and disabling decompression

Parameters:

ocspMode - OCSP mode

Returns:

HttpClient object shared across all connections

initHttpClientWithoutDecompression

public static org.apache.http.impl.client.CloseableHttpClient initHttpClientWithoutDecompression(OCSPMode ocspMode,
                                                                                                 File ocspCacheFile)

Accessor for the HTTP client singleton.

Parameters:

ocspMode - OCSP mode

ocspCacheFile - OCSP response cache file name. if null, the default file will be used.

Returns:

HttpClient object shared across all connections

initHttpClient

public static org.apache.http.impl.client.CloseableHttpClient initHttpClient(OCSPMode ocspMode,
                                                                             File ocspCacheFile)

Accessor for the HTTP client singleton.

Parameters:

ocspMode - OCSP mode

ocspCacheFile - OCSP response cache file name. if null, the default file will be used.

Returns:

HttpClient object shared across all connections

getDefaultRequestConfigWithSocketTimeout

public static org.apache.http.client.config.RequestConfig getDefaultRequestConfigWithSocketTimeout(int soTimeoutMs,
                                                                                                   boolean withoutCookies)

Return a request configuration inheriting from the default request configuration of the shared HttpClient with a different socket timeout.

Parameters:

soTimeoutMs - - custom socket timeout in milli-seconds

withoutCookies - - whether this request should ignore cookies or not

Returns:

RequestConfig object

getRequestConfigWithoutCookies

public static org.apache.http.client.config.RequestConfig getRequestConfigWithoutCookies()

Return a request configuration inheriting from the default request configuration of the shared HttpClient with the coopkie spec set to ignore.

Returns:

RequestConfig object

setRequestConfig

public static void setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)

setSocksProxyDisabled

public static void setSocksProxyDisabled(boolean socksProxyDisabled)

Enables/disables use of the SOCKS proxy when creating sockets

Parameters:

socksProxyDisabled - new value

isSocksProxyDisabled

public static boolean isSocksProxyDisabled()

Returns whether the SOCKS proxy is disabled for this JVM

Returns:

whether the SOCKS proxy is disabled

executeGeneralRequest

public static String executeGeneralRequest(org.apache.http.client.methods.HttpRequestBase httpRequest,
                                           int retryTimeout,
                                           OCSPMode ocspMode)
                                    throws SnowflakeSQLException,
                                           IOException

Executes a HTTP request for Snowflake.

Parameters:

httpRequest - HttpRequestBase

retryTimeout - retry timeout

ocspMode - OCSP mode

Returns:

response

Throws:

SnowflakeSQLException - if Snowflake error occurs

IOException - raises if a general IO error occurs

executeRequest

public static String executeRequest(org.apache.http.client.methods.HttpRequestBase httpRequest,
                                    int retryTimeout,
                                    int injectSocketTimeout,
                                    AtomicBoolean canceling,
                                    boolean includeRetryParameters,
                                    boolean retryOnHTTP403,
                                    OCSPMode ocspMode)
                             throws SnowflakeSQLException,
                                    IOException

Executes a HTTP request for Snowflake.

Parameters:

httpRequest - HttpRequestBase

retryTimeout - retry timeout

injectSocketTimeout - injecting socket timeout

canceling - canceling?

includeRetryParameters - whether to include retry parameters in retried requests

retryOnHTTP403 - whether to retry on HTTP 403 or not

ocspMode - OCSP mode

Returns:

response

Throws:

SnowflakeSQLException - if Snowflake error occurs

IOException - raises if a general IO error occurs

configureCustomProxyProperties

public static void configureCustomProxyProperties(Map<SFSessionProperty,Object> connectionPropertiesMap)
                                           throws SnowflakeSQLException

configure custom proxy properties from connectionPropertiesMap

Throws:

SnowflakeSQLException