net.snowflake.client.core

Class SessionUtil

java.lang.Object

net.snowflake.client.core.SessionUtil

public class SessionUtil
extends Object

Low level session util

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_FILE_NAME
static String	CLIENT_ENABLE_CONSERVATIVE_MEMORY_USAGE
static String	CLIENT_ENABLE_CONSERVATIVE_MEMORY_USAGE_JVM
static String	CLIENT_IN_BAND_TELEMETRY_ENABLED
static String	CLIENT_MEMORY_LIMIT
static String	CLIENT_MEMORY_LIMIT_JVM
static String	CLIENT_OUT_OF_BAND_TELEMETRY_ENABLED
static String	CLIENT_PREFETCH_THREADS
static String	CLIENT_PREFETCH_THREADS_JVM
static String	CLIENT_RESULT_CHUNK_SIZE
static String	CLIENT_RESULT_CHUNK_SIZE_JVM
static String	CLIENT_RESULT_COLUMN_CASE_INSENSITIVE
static String	CLIENT_SESSION_KEEP_ALIVE_HEARTBEAT_FREQUENCY
static String	CLIENT_SFSQL
static String	CLIENT_STORE_TEMPORARY_CREDENTIAL
static int	DEFAULT_CLIENT_CHUNK_SIZE
static long	DEFAULT_CLIENT_MEMORY_LIMIT
static int	DEFAULT_CLIENT_PREFETCH_THREADS
static String	JDBC_RS_COLUMN_CASE_INSENSITIVE
static Map<String,String>	JVM_PARAMS_TO_PARAMS
static int	MAX_CLIENT_CHUNK_SIZE
static int	MIN_CLIENT_CHUNK_SIZE
static String	OCSP_FAIL_OPEN
static String	OCSP_FAIL_OPEN_JVM
static String	SERVICE_NAME
static String	SF_HEADER_AUTHORIZATION
static String	SF_HEADER_BASIC_AUTHTYPE
static String	SF_HEADER_SNOWFLAKE_AUTHTYPE
static String	SF_HEADER_TOKEN_TAG
protected static String	SF_PATH_AUTHENTICATOR_REQUEST
static String	SF_QUERY_SESSION_DELETE

Constructor Summary

Constructors

Constructor and Description
SessionUtil()

Method Summary

Modifier and Type	Method and Description
static void	closeSession(SFLoginInput loginInput) Close a session
static void	deleteIdTokenCache() Delete the id token cache
static Map<String,Object>	getCommonParams(com.fasterxml.jackson.databind.JsonNode paramsNode) Helper function to parse a JsonNode from a GS response containing CommonParameters, emitting an EnumMap of parameters
static SFLoginOutput	issueSession(SFLoginInput loginInput) Issue a session
static SFLoginOutput	openSession(SFLoginInput loginInput) Open a new session
static SFLoginOutput	renewSession(SFLoginInput loginInput) Renew a session.
static void	updateSfDriverParamValues(Map<String,Object> parameters, SFSession session)

Methods inherited from class java.lang.Object

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

Field Detail

SF_PATH_AUTHENTICATOR_REQUEST

protected static final String SF_PATH_AUTHENTICATOR_REQUEST

See Also:

Constant Field Values

SF_QUERY_SESSION_DELETE

public static final String SF_QUERY_SESSION_DELETE

See Also:

Constant Field Values

SF_HEADER_AUTHORIZATION

public static final String SF_HEADER_AUTHORIZATION

See Also:

Constant Field Values

SF_HEADER_BASIC_AUTHTYPE

public static final String SF_HEADER_BASIC_AUTHTYPE

See Also:

Constant Field Values

SF_HEADER_SNOWFLAKE_AUTHTYPE

public static final String SF_HEADER_SNOWFLAKE_AUTHTYPE

See Also:

Constant Field Values

SF_HEADER_TOKEN_TAG

public static final String SF_HEADER_TOKEN_TAG

See Also:

Constant Field Values

CLIENT_STORE_TEMPORARY_CREDENTIAL

public static final String CLIENT_STORE_TEMPORARY_CREDENTIAL

See Also:

Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

CLIENT_IN_BAND_TELEMETRY_ENABLED

public static final String CLIENT_IN_BAND_TELEMETRY_ENABLED

See Also:

Constant Field Values

CLIENT_OUT_OF_BAND_TELEMETRY_ENABLED

public static final String CLIENT_OUT_OF_BAND_TELEMETRY_ENABLED

See Also:

Constant Field Values

CLIENT_RESULT_COLUMN_CASE_INSENSITIVE

public static final String CLIENT_RESULT_COLUMN_CASE_INSENSITIVE

See Also:

Constant Field Values

JDBC_RS_COLUMN_CASE_INSENSITIVE

public static final String JDBC_RS_COLUMN_CASE_INSENSITIVE

See Also:

Constant Field Values

CLIENT_RESULT_CHUNK_SIZE_JVM

public static final String CLIENT_RESULT_CHUNK_SIZE_JVM

See Also:

Constant Field Values

CLIENT_RESULT_CHUNK_SIZE

public static final String CLIENT_RESULT_CHUNK_SIZE

See Also:

Constant Field Values

CLIENT_MEMORY_LIMIT_JVM

public static final String CLIENT_MEMORY_LIMIT_JVM

See Also:

Constant Field Values

CLIENT_MEMORY_LIMIT

public static final String CLIENT_MEMORY_LIMIT

See Also:

Constant Field Values

CLIENT_PREFETCH_THREADS_JVM

public static final String CLIENT_PREFETCH_THREADS_JVM

See Also:

Constant Field Values

CLIENT_PREFETCH_THREADS

public static final String CLIENT_PREFETCH_THREADS

See Also:

Constant Field Values

CLIENT_ENABLE_CONSERVATIVE_MEMORY_USAGE_JVM

public static final String CLIENT_ENABLE_CONSERVATIVE_MEMORY_USAGE_JVM

See Also:

Constant Field Values

CLIENT_ENABLE_CONSERVATIVE_MEMORY_USAGE

public static final String CLIENT_ENABLE_CONSERVATIVE_MEMORY_USAGE

See Also:

Constant Field Values

CACHE_FILE_NAME

public static final String CACHE_FILE_NAME

See Also:

Constant Field Values

OCSP_FAIL_OPEN_JVM

public static final String OCSP_FAIL_OPEN_JVM

See Also:

Constant Field Values

OCSP_FAIL_OPEN

public static final String OCSP_FAIL_OPEN

See Also:

Constant Field Values

CLIENT_SESSION_KEEP_ALIVE_HEARTBEAT_FREQUENCY

public static final String CLIENT_SESSION_KEEP_ALIVE_HEARTBEAT_FREQUENCY

See Also:

Constant Field Values

CLIENT_SFSQL

public static final String CLIENT_SFSQL

See Also:

Constant Field Values

DEFAULT_CLIENT_MEMORY_LIMIT

public static long DEFAULT_CLIENT_MEMORY_LIMIT

DEFAULT_CLIENT_PREFETCH_THREADS

public static int DEFAULT_CLIENT_PREFETCH_THREADS

DEFAULT_CLIENT_CHUNK_SIZE

public static int DEFAULT_CLIENT_CHUNK_SIZE

MIN_CLIENT_CHUNK_SIZE

public static int MIN_CLIENT_CHUNK_SIZE

MAX_CLIENT_CHUNK_SIZE

public static int MAX_CLIENT_CHUNK_SIZE

JVM_PARAMS_TO_PARAMS

public static Map<String,String> JVM_PARAMS_TO_PARAMS

Constructor Detail

SessionUtil

public SessionUtil()

Method Detail

openSession

public static SFLoginOutput openSession(SFLoginInput loginInput)
                                 throws SFException,
                                        SnowflakeSQLException

Open a new session

Parameters:

loginInput - login information

Returns:

information get after login such as token information

Throws:

SFException - if unexpected uri syntax

SnowflakeSQLException - if failed to establish connection with snowflake

deleteIdTokenCache

public static void deleteIdTokenCache()

Delete the id token cache

renewSession

public static SFLoginOutput renewSession(SFLoginInput loginInput)
                                  throws SFException,
                                         SnowflakeSQLException

Renew a session.

Use cases: - Session and Master tokens are provided. No Id token: - succeed in getting a new Session token. - fail and raise SnowflakeReauthenticationRequest because Master token expires. Since no id token exists, the exception is thrown to the upstream. - Session and Id tokens are provided. No Master token: - fail and raise SnowflakeReauthenticationRequest and issue a new Session token - fail and raise SnowflakeReauthenticationRequest and fail to issue a new Session token as the

Parameters:

loginInput - login information

Returns:

login output

Throws:

SFException - if unexpected uri information

SnowflakeSQLException - if failed to renew the session

issueSession

public static SFLoginOutput issueSession(SFLoginInput loginInput)
                                  throws SFException,
                                         SnowflakeSQLException

Issue a session

Parameters:

loginInput - login information

Returns:

login output

Throws:

SFException - if unexpected uri information

SnowflakeSQLException - if failed to renew the session

closeSession

public static void closeSession(SFLoginInput loginInput)
                         throws SFException,
                                SnowflakeSQLException

Close a session

Parameters:

loginInput - login information

Throws:

SnowflakeSQLException - if failed to close session

SFException - if failed to close session

getCommonParams

public static Map<String,Object> getCommonParams(com.fasterxml.jackson.databind.JsonNode paramsNode)

Helper function to parse a JsonNode from a GS response containing CommonParameters, emitting an EnumMap of parameters

Parameters:

paramsNode - parameters in JSON form

Returns:

map object including key and value pairs

updateSfDriverParamValues

public static void updateSfDriverParamValues(Map<String,Object> parameters,
                                             SFSession session)