com.mysql.cj

Interface CharsetSettings

All Known Implementing Classes:

NativeCharsetSettings

public interface CharsetSettings

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHARACTER_SET_CLIENT
static java.lang.String	CHARACTER_SET_CONNECTION
static java.lang.String	CHARACTER_SET_RESULTS
static java.lang.String	COLLATION_CONNECTION

Method Summary

Modifier and Type	Method and Description
void	configurePostHandshake(boolean dontCheckServerMatch) Sets up client character set.
int	configurePreHandshake(boolean reset) Choose the MySQL collation index for the handshake packet and the corresponding Java encodings for the password and error messages.
boolean	doesPlatformDbCharsetMatches()
java.lang.Integer	getCollationIndexForCollationName(java.lang.String collationName)
int	getCollationIndexForJavaEncoding(java.lang.String javaEncoding, ServerVersion version)
int	getCollationIndexForMysqlCharsetName(java.lang.String charsetName)
java.lang.String	getCollationNameForCollationIndex(java.lang.Integer collationIndex)
java.lang.String	getErrorMessageEncoding()
java.lang.String	getJavaEncodingForCollationIndex(int collationIndex)
java.lang.String	getJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName)
int	getMaxBytesPerChar(java.lang.Integer charsetIndex, java.lang.String javaCharsetName)
int	getMaxBytesPerChar(java.lang.String javaCharsetName)
int	getMetadataCollationIndex()
java.lang.String	getMetadataEncoding()
java.lang.String	getMysqlCharsetForJavaEncoding(java.lang.String javaEncoding, ServerVersion version)
java.lang.String	getMysqlCharsetNameForCollationIndex(java.lang.Integer collationIndex)
java.lang.String	getPasswordCharacterEncoding()
boolean	getRequiresEscapingEncoder()
boolean	isMultibyteCharset(java.lang.String javaEncodingName)

Field Detail

CHARACTER_SET_CLIENT

static final java.lang.String CHARACTER_SET_CLIENT

See Also:

Constant Field Values

CHARACTER_SET_CONNECTION

static final java.lang.String CHARACTER_SET_CONNECTION

See Also:

Constant Field Values

CHARACTER_SET_RESULTS

static final java.lang.String CHARACTER_SET_RESULTS

See Also:

Constant Field Values

COLLATION_CONNECTION

static final java.lang.String COLLATION_CONNECTION

See Also:

Constant Field Values

Method Detail

configurePreHandshake

int configurePreHandshake(boolean reset)

Choose the MySQL collation index for the handshake packet and the corresponding Java encodings for the password and error messages.

This index will be sent with HandshakeResponse setting server variables 'character_set_connection', 'collation_connection', 'character_set_client' and 'character_set_results' which will be used by the server for decoding passwords during the authentication phase and later on, if no SET NAMES are issued by configurePostHandshake(boolean).

It also means that collation index should be set according to:

1. 'passwordCharacterEncoding' if it's present, or
2. 'connectionCollation' if it's present, or
3. 'characterEncoding' if it's present

otherwise it will be set to utf8mb4_general_ci or utf8mb4_0900_ai_ci depending on server version.

Since Protocol::HandshakeV10 and Protocol::HandshakeResponse41 has only one byte for the collation it's not possible to use indexes > 255 during the handshake. Also, ucs2, utf16, utf16le and utf32 character sets are impermissible here. Connector/J will try to use utf8mb4 instead.

Parameters:

reset - reset the charsets configuration; needed for changeUser call.

Returns:

MySQL collation index to be used during the handshake.

configurePostHandshake

void configurePostHandshake(boolean dontCheckServerMatch)

Sets up client character set. This must be done before any further communication with the server! The 'collation_connection', 'character_set_client', 'character_set_connection' and 'character_set_results' server variables are set according to the collation index selected by configurePreHandshake(boolean) and sent in the Protocol::HandshakeV10 packet. Here Connector/J alters these server variables if needed.

Parameters:

dontCheckServerMatch - if true then send the SET NAMES query even if server charset already matches the new value; needed for changeUser call.

doesPlatformDbCharsetMatches

boolean doesPlatformDbCharsetMatches()

getPasswordCharacterEncoding

java.lang.String getPasswordCharacterEncoding()

getErrorMessageEncoding

java.lang.String getErrorMessageEncoding()

getMetadataEncoding

java.lang.String getMetadataEncoding()

getMetadataCollationIndex

int getMetadataCollationIndex()

getRequiresEscapingEncoder

boolean getRequiresEscapingEncoder()

getJavaEncodingForCollationIndex

java.lang.String getJavaEncodingForCollationIndex(int collationIndex)

getMaxBytesPerChar

int getMaxBytesPerChar(java.lang.String javaCharsetName)

getMaxBytesPerChar

int getMaxBytesPerChar(java.lang.Integer charsetIndex,
                       java.lang.String javaCharsetName)

getCollationIndexForCollationName

java.lang.Integer getCollationIndexForCollationName(java.lang.String collationName)

getCollationNameForCollationIndex

java.lang.String getCollationNameForCollationIndex(java.lang.Integer collationIndex)

getMysqlCharsetNameForCollationIndex

java.lang.String getMysqlCharsetNameForCollationIndex(java.lang.Integer collationIndex)

getCollationIndexForJavaEncoding

int getCollationIndexForJavaEncoding(java.lang.String javaEncoding,
                                     ServerVersion version)

getCollationIndexForMysqlCharsetName

int getCollationIndexForMysqlCharsetName(java.lang.String charsetName)

getJavaEncodingForMysqlCharset

java.lang.String getJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName)

getMysqlCharsetForJavaEncoding

java.lang.String getMysqlCharsetForJavaEncoding(java.lang.String javaEncoding,
                                                ServerVersion version)

isMultibyteCharset

boolean isMultibyteCharset(java.lang.String javaEncodingName)