com.mysql.cj

Class NativeCharsetSettings

java.lang.Object

com.mysql.cj.CharsetMapping

com.mysql.cj.NativeCharsetSettings

All Implemented Interfaces:

CharsetSettings

public class NativeCharsetSettings
extends CharsetMapping
implements CharsetSettings

Field Summary

Fields

Modifier and Type	Field and Description
protected RuntimeProperty<java.lang.Boolean>	cacheServerConfiguration
protected RuntimeProperty<java.lang.String>	characterEncoding
protected RuntimeProperty<java.lang.String>	characterSetResults
java.util.Map<java.lang.String,java.lang.Integer>	charsetNameToCollationIndex
java.util.Map<java.lang.String,java.lang.String>	charsetNameToJavaEncoding
java.util.Map<java.lang.String,java.lang.Integer>	charsetNameToMblen
java.util.Map<java.lang.Integer,java.lang.String>	collationIndexToCharsetName
java.util.Map<java.lang.Integer,java.lang.String>	collationIndexToCollationName
java.util.Map<java.lang.String,java.lang.Integer>	collationNameToCollationIndex
private NativeMessageBuilder	commandBuilder
protected RuntimeProperty<java.lang.String>	connectionCollation
private static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	customCharsetNameToCollationIndexByUrl
private static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	customCharsetNameToJavaEncodingByUrl
private static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	customCharsetNameToMblenByUrl Actual mysql charset name to mblen map of user defined charsets for given server URLs.
private static java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>>	customCollationIndexToCharsetNameByUrl Actual collation index to mysql charset name map of user defined charsets for given server URLs.
private static java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>>	customCollationIndexToCollationNameByUrl
private static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	customCollationNameToCollationIndexByUrl
private static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	customJavaEncodingUcToCharsetNameByUrl
private static java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	customMultibyteEncodingsByUrl
private java.lang.String	errorMessageEncoding The (Java) encoding used to interpret error messages received from the server.
java.util.Map<java.lang.String,java.lang.String>	javaEncodingUcToCharsetName
private int	metadataCollationIndex
private java.lang.String	metadataEncoding What character set is the metadata returned in?
java.util.Set<java.lang.String>	multibyteEncodings
protected RuntimeProperty<java.lang.String>	passwordCharacterEncoding
private boolean	platformDbCharsetMatches Does the character set of this connection match the character set of the platform
private boolean	requiresEscapingEncoder If a CharsetEncoder is required for escaping.
private ServerSession	serverSession
private NativeSession	session
private java.lang.Integer	sessionCollationIndex

Fields inherited from class com.mysql.cj.CharsetMapping

MAP_SIZE, MYSQL_CHARSET_NAME_armscii8, MYSQL_CHARSET_NAME_ascii, MYSQL_CHARSET_NAME_big5, MYSQL_CHARSET_NAME_binary, MYSQL_CHARSET_NAME_cp1250, MYSQL_CHARSET_NAME_cp1251, MYSQL_CHARSET_NAME_cp1256, MYSQL_CHARSET_NAME_cp1257, MYSQL_CHARSET_NAME_cp850, MYSQL_CHARSET_NAME_cp852, MYSQL_CHARSET_NAME_cp866, MYSQL_CHARSET_NAME_cp932, MYSQL_CHARSET_NAME_dec8, MYSQL_CHARSET_NAME_eucjpms, MYSQL_CHARSET_NAME_euckr, MYSQL_CHARSET_NAME_gb18030, MYSQL_CHARSET_NAME_gb2312, MYSQL_CHARSET_NAME_gbk, MYSQL_CHARSET_NAME_geostd8, MYSQL_CHARSET_NAME_greek, MYSQL_CHARSET_NAME_hebrew, MYSQL_CHARSET_NAME_hp8, MYSQL_CHARSET_NAME_keybcs2, MYSQL_CHARSET_NAME_koi8r, MYSQL_CHARSET_NAME_koi8u, MYSQL_CHARSET_NAME_latin1, MYSQL_CHARSET_NAME_latin2, MYSQL_CHARSET_NAME_latin5, MYSQL_CHARSET_NAME_latin7, MYSQL_CHARSET_NAME_macce, MYSQL_CHARSET_NAME_macroman, MYSQL_CHARSET_NAME_sjis, MYSQL_CHARSET_NAME_swe7, MYSQL_CHARSET_NAME_tis620, MYSQL_CHARSET_NAME_ucs2, MYSQL_CHARSET_NAME_ujis, MYSQL_CHARSET_NAME_utf16, MYSQL_CHARSET_NAME_utf16le, MYSQL_CHARSET_NAME_utf32, MYSQL_CHARSET_NAME_utf8, MYSQL_CHARSET_NAME_utf8mb3, MYSQL_CHARSET_NAME_utf8mb4, MYSQL_COLLATION_INDEX_binary, MYSQL_COLLATION_INDEX_utf8mb4_0900_ai_ci, MYSQL_COLLATION_INDEX_utf8mb4_general_ci

Fields inherited from interface com.mysql.cj.CharsetSettings

CHARACTER_SET_CLIENT, CHARACTER_SET_CONNECTION, CHARACTER_SET_RESULTS, COLLATION_CONNECTION

Constructor Summary

Constructors

Constructor and Description
NativeCharsetSettings(NativeSession sess)

Method Summary

Modifier and Type	Method and Description
private void	buildCollationMapping() Builds the map needed for 4.1.0 and newer servers that maps field-level charset/collation info to a java character encoding name.
private boolean	characterSetNamesMatches(java.lang.String mysqlEncodingName)
private void	checkForCharsetMismatch() Determines if the connection charset is the same as the platform charset
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)
private NativeMessageBuilder	getCommandBuilder()
java.lang.String	getErrorMessageEncoding()
java.lang.String	getJavaEncodingForCollationIndex(int collationIndex)
java.lang.String	getJavaEncodingForCollationIndex(java.lang.Integer collationIndex, java.lang.String fallBackJavaEncoding)
java.lang.String	getJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName)
java.lang.String	getJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName, java.lang.String javaEncoding)
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()
java.lang.String	getServerDefaultCharset() Get the server's default character set name according to collation index from server greeting, or value of 'character_set_server' variable if there is no mapping for that index
boolean	isImpermissibleCollation(int collationIndex)
boolean	isMultibyteCharset(java.lang.String javaEncodingName)
private void	tryAndFixEncoding(RuntimeProperty<java.lang.String> encodingProperty, boolean replaceImpermissibleEncodings) Attempt to use the encoding, and bail out if it can't be used.

Methods inherited from class com.mysql.cj.CharsetMapping

getStaticCollationIndexForCollationName, getStaticCollationIndexForJavaEncoding, getStaticCollationIndexForMysqlCharsetName, getStaticCollationNameForCollationIndex, getStaticJavaEncodingForCollationIndex, getStaticJavaEncodingForCollationIndex, getStaticJavaEncodingForMysqlCharset, getStaticJavaEncodingForMysqlCharset, getStaticMblen, getStaticMysqlCharsetAliasesByName, getStaticMysqlCharsetByName, getStaticMysqlCharsetForJavaEncoding, getStaticMysqlCharsetNameForCollationIndex, isStaticImpermissibleCollation, isStaticMultibyteCharset

Methods inherited from class java.lang.Object

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

Field Detail

session

private NativeSession session

serverSession

private ServerSession serverSession

collationIndexToCollationName

public java.util.Map<java.lang.Integer,java.lang.String> collationIndexToCollationName

collationNameToCollationIndex

public java.util.Map<java.lang.String,java.lang.Integer> collationNameToCollationIndex

collationIndexToCharsetName

public java.util.Map<java.lang.Integer,java.lang.String> collationIndexToCharsetName

charsetNameToMblen

public java.util.Map<java.lang.String,java.lang.Integer> charsetNameToMblen

charsetNameToJavaEncoding

public java.util.Map<java.lang.String,java.lang.String> charsetNameToJavaEncoding

charsetNameToCollationIndex

public java.util.Map<java.lang.String,java.lang.Integer> charsetNameToCollationIndex

javaEncodingUcToCharsetName

public java.util.Map<java.lang.String,java.lang.String> javaEncodingUcToCharsetName

multibyteEncodings

public java.util.Set<java.lang.String> multibyteEncodings

sessionCollationIndex

private java.lang.Integer sessionCollationIndex

metadataEncoding

private java.lang.String metadataEncoding

What character set is the metadata returned in?

metadataCollationIndex

private int metadataCollationIndex

errorMessageEncoding

private java.lang.String errorMessageEncoding

The (Java) encoding used to interpret error messages received from the server. We use character_set_results (since MySQL 5.5) if it is not null or UTF-8 otherwise.

characterEncoding

protected RuntimeProperty<java.lang.String> characterEncoding

passwordCharacterEncoding

protected RuntimeProperty<java.lang.String> passwordCharacterEncoding

characterSetResults

protected RuntimeProperty<java.lang.String> characterSetResults

connectionCollation

protected RuntimeProperty<java.lang.String> connectionCollation

cacheServerConfiguration

protected RuntimeProperty<java.lang.Boolean> cacheServerConfiguration

requiresEscapingEncoder

private boolean requiresEscapingEncoder

If a CharsetEncoder is required for escaping. Needed for SJIS and related problems with ¥.

commandBuilder

private NativeMessageBuilder commandBuilder

customCollationIndexToCollationNameByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>> customCollationIndexToCollationNameByUrl

customCollationNameToCollationIndexByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> customCollationNameToCollationIndexByUrl

customCollationIndexToCharsetNameByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>> customCollationIndexToCharsetNameByUrl

Actual collation index to mysql charset name map of user defined charsets for given server URLs.

customCharsetNameToMblenByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> customCharsetNameToMblenByUrl

Actual mysql charset name to mblen map of user defined charsets for given server URLs.

customCharsetNameToJavaEncodingByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> customCharsetNameToJavaEncodingByUrl

customCharsetNameToCollationIndexByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> customCharsetNameToCollationIndexByUrl

customJavaEncodingUcToCharsetNameByUrl

private static final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> customJavaEncodingUcToCharsetNameByUrl

customMultibyteEncodingsByUrl

private static final java.util.Map<java.lang.String,java.util.Set<java.lang.String>> customMultibyteEncodingsByUrl

platformDbCharsetMatches

private boolean platformDbCharsetMatches

Does the character set of this connection match the character set of the platform

Constructor Detail

NativeCharsetSettings

public NativeCharsetSettings(NativeSession sess)

Method Detail

getCommandBuilder

private NativeMessageBuilder getCommandBuilder()

checkForCharsetMismatch

private void checkForCharsetMismatch()

Determines if the connection charset is the same as the platform charset

doesPlatformDbCharsetMatches

public boolean doesPlatformDbCharsetMatches()

Specified by:

doesPlatformDbCharsetMatches in interface CharsetSettings

tryAndFixEncoding

private void tryAndFixEncoding(RuntimeProperty<java.lang.String> encodingProperty,
                               boolean replaceImpermissibleEncodings)

Attempt to use the encoding, and bail out if it can't be used.

Parameters:

encodingProperty - connection property containing the Java encoding to try

replaceImpermissibleEncodings - The character_set_client system variable cannot be set to ucs2, utf16, utf16le, utf32 charsets. If "true" the corresponding connection property value will be replaced with "UTF-8"

configurePreHandshake

public int configurePreHandshake(boolean reset)

Description copied from interface: CharsetSettings

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 CharsetSettings.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.

Specified by:

configurePreHandshake in interface CharsetSettings

Parameters:

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

Returns:

MySQL collation index to be used during the handshake.

configurePostHandshake

public void configurePostHandshake(boolean dontCheckServerMatch)

Description copied from interface: CharsetSettings

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 CharsetSettings.configurePreHandshake(boolean) and sent in the Protocol::HandshakeV10 packet. Here Connector/J alters these server variables if needed.

Specified by:

configurePostHandshake in interface CharsetSettings

Parameters:

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

characterSetNamesMatches

private boolean characterSetNamesMatches(java.lang.String mysqlEncodingName)

getServerDefaultCharset

public java.lang.String getServerDefaultCharset()

Get the server's default character set name according to collation index from server greeting, or value of 'character_set_server' variable if there is no mapping for that index

Returns:

MySQL charset name

getErrorMessageEncoding

public java.lang.String getErrorMessageEncoding()

Specified by:

getErrorMessageEncoding in interface CharsetSettings

getMetadataEncoding

public java.lang.String getMetadataEncoding()

Specified by:

getMetadataEncoding in interface CharsetSettings

getMetadataCollationIndex

public int getMetadataCollationIndex()

Specified by:

getMetadataCollationIndex in interface CharsetSettings

getRequiresEscapingEncoder

public boolean getRequiresEscapingEncoder()

Specified by:

getRequiresEscapingEncoder in interface CharsetSettings

getPasswordCharacterEncoding

public java.lang.String getPasswordCharacterEncoding()

Specified by:

getPasswordCharacterEncoding in interface CharsetSettings

buildCollationMapping

private void buildCollationMapping()

Builds the map needed for 4.1.0 and newer servers that maps field-level charset/collation info to a java character encoding name.

getCollationIndexForCollationName

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

Specified by:

getCollationIndexForCollationName in interface CharsetSettings

getCollationNameForCollationIndex

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

Specified by:

getCollationNameForCollationIndex in interface CharsetSettings

getMysqlCharsetNameForCollationIndex

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

Specified by:

getMysqlCharsetNameForCollationIndex in interface CharsetSettings

getJavaEncodingForCollationIndex

public java.lang.String getJavaEncodingForCollationIndex(int collationIndex)

Specified by:

getJavaEncodingForCollationIndex in interface CharsetSettings

getJavaEncodingForCollationIndex

public java.lang.String getJavaEncodingForCollationIndex(java.lang.Integer collationIndex,
                                                         java.lang.String fallBackJavaEncoding)

getCollationIndexForJavaEncoding

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

Specified by:

getCollationIndexForJavaEncoding in interface CharsetSettings

getCollationIndexForMysqlCharsetName

public int getCollationIndexForMysqlCharsetName(java.lang.String charsetName)

Specified by:

getCollationIndexForMysqlCharsetName in interface CharsetSettings

getJavaEncodingForMysqlCharset

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

Specified by:

getJavaEncodingForMysqlCharset in interface CharsetSettings

getJavaEncodingForMysqlCharset

public java.lang.String getJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName,
                                                       java.lang.String javaEncoding)

getMysqlCharsetForJavaEncoding

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

Specified by:

getMysqlCharsetForJavaEncoding in interface CharsetSettings

isImpermissibleCollation

public boolean isImpermissibleCollation(int collationIndex)

isMultibyteCharset

public boolean isMultibyteCharset(java.lang.String javaEncodingName)

Specified by:

isMultibyteCharset in interface CharsetSettings

getMaxBytesPerChar

public int getMaxBytesPerChar(java.lang.String javaCharsetName)

Specified by:

getMaxBytesPerChar in interface CharsetSettings

getMaxBytesPerChar

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

Specified by:

getMaxBytesPerChar in interface CharsetSettings