com.heimuheimu.mysql.jdbc.packet.connection

类 HandshakeResponse41Packet

java.lang.Object

com.heimuheimu.mysql.jdbc.packet.connection.HandshakeResponse41Packet

public class HandshakeResponse41Packet
extends java.lang.Object

"HandshakeResponse41Packet" 数据包信息，Mysql 客户端在收到 HandshakeV10Packet 数据包后，将发送该响应数据包至服务端，更多信息请参考： Protocol::HandshakeResponse41

说明：HandshakeResponse41Packet 类是非线程安全的，不允许多个线程使用同一个实例。

作者:

heimuheimu

构造器概要

构造器

构造器和说明
HandshakeResponse41Packet()

方法概要

限定符和类型	方法和说明
void	addClientConnectionAttribute(java.lang.String key, java.lang.String value) 添加一个 Mysql 客户端属性键值对。
byte[]	buildMysqlPacketBytes(long serverCapabilitiesFlags) 根据当前 HandshakeResponse41Packet 实例信息，生成对应的 Mysql "HandshakeResponse41Packet" 数据包字节数组， "HandshakeResponse41Packet" 数据包格式定义： Protocol::HandshakeResponse41 注意：调用该方法后，capabilitiesFlags 将会被重新赋值，默认特性将被开启，已指定开启但 Mysql 服务端不支持的特性将会被关闭。
java.lang.String	getAuthPluginName() 获得 Mysql 客户端可使用的授权插件名称。
byte[]	getAuthResponse() 获得 Mysql 数据库密码加密字节数组。
long	getCapabilitiesFlags() 获得 Mysql 客户端可使用的特性数值。
int	getClientCharacterId() 获得 Mysql 客户端字符集编码 ID，ID 对应的编码可通过数据库表 "information_schema.collations" 进行查询。
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getClientConnectionAttributeMap() 获得 Mysql 客户端属性键值对 Map，Key 为属性名称，Value 为属性值。
java.lang.String	getDatabaseName() 获得 Mysql 数据库名称。
java.lang.String	getUsername() 获得 Mysql 数据库用户名。
void	setAuthPluginName(java.lang.String authPluginName) 设置 Mysql 客户端可使用的授权插件名称。
void	setAuthResponse(byte[] authResponse) 设置 Mysql 数据库密码加密字节数组。
void	setCapabilitiesFlags(long capabilitiesFlags) 设置 Mysql 客户端可使用的特性数值。
void	setClientCharacterId(int clientCharacterId) 设置 Mysql 客户端字符集编码 ID。
void	setDatabaseName(java.lang.String databaseName) 设置 Mysql 数据库名称。
void	setUsername(java.lang.String username) 设置 Mysql 数据库用户名。
java.lang.String	toString()

从类继承的方法 java.lang.Object

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

构造器详细资料

HandshakeResponse41Packet

public HandshakeResponse41Packet()

方法详细资料

getCapabilitiesFlags

public long getCapabilitiesFlags()

获得 Mysql 客户端可使用的特性数值。

返回:

Mysql 客户端可使用的特性数值

setCapabilitiesFlags

public void setCapabilitiesFlags(long capabilitiesFlags)

设置 Mysql 客户端可使用的特性数值。

参数:

capabilitiesFlags - Mysql 客户端可使用的特性数值

getClientCharacterId

public int getClientCharacterId()

获得 Mysql 客户端字符集编码 ID，ID 对应的编码可通过数据库表 "information_schema.collations" 进行查询。

默认为：45 (utf8mb4_general_ci)

返回:

Mysql 客户端字符集编码 ID

setClientCharacterId

public void setClientCharacterId(int clientCharacterId)
                          throws java.lang.IllegalArgumentException

设置 Mysql 客户端字符集编码 ID。

参数:

clientCharacterId - Mysql 客户端字符集编码 ID，值允许的范围为：[0, 255]

抛出:

java.lang.IllegalArgumentException - 如果 clientCharacterId 的值不在允许的范围内，将会抛出此异常

getUsername

public java.lang.String getUsername()

获得 Mysql 数据库用户名。

返回:

Mysql 数据库用户名

setUsername

public void setUsername(java.lang.String username)
                 throws java.lang.IllegalArgumentException

设置 Mysql 数据库用户名。

参数:

username - Mysql 数据库用户名，不允许为 null 或空

抛出:

java.lang.IllegalArgumentException - 如果 username 为 null 或空，将会抛出此异常

getAuthResponse

public byte[] getAuthResponse()

获得 Mysql 数据库密码加密字节数组。

返回:

Mysql 数据库密码加密字节数组

setAuthResponse

public void setAuthResponse(byte[] authResponse)
                     throws java.lang.NullPointerException

设置 Mysql 数据库密码加密字节数组。

参数:

authResponse - Mysql 数据库密码加密字节数组，不允许为 null

抛出:

java.lang.NullPointerException - 如果 authResponse 为 null，将抛出此异常

getDatabaseName

public java.lang.String getDatabaseName()

获得 Mysql 数据库名称。

返回:

Mysql 数据库名称

setDatabaseName

public void setDatabaseName(java.lang.String databaseName)

设置 Mysql 数据库名称。

参数:

databaseName - Mysql 数据库名称，允许为 null 或空

getAuthPluginName

public java.lang.String getAuthPluginName()

获得 Mysql 客户端可使用的授权插件名称。

返回:

Mysql 客户端可使用的授权插件名称

setAuthPluginName

public void setAuthPluginName(java.lang.String authPluginName)
                       throws java.lang.IllegalArgumentException

设置 Mysql 客户端可使用的授权插件名称。

参数:

authPluginName - Mysql 客户端可使用的授权插件名称，不允许为 null 或空

抛出:

java.lang.IllegalArgumentException - 如果 authPluginName 为 null 或空，将会抛出此异常

getClientConnectionAttributeMap

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getClientConnectionAttributeMap()

获得 Mysql 客户端属性键值对 Map，Key 为属性名称，Value 为属性值。

返回:

Mysql 客户端属性键值对 Map

addClientConnectionAttribute

public void addClientConnectionAttribute(java.lang.String key,
                                         java.lang.String value)
                                  throws java.lang.IllegalArgumentException

添加一个 Mysql 客户端属性键值对。

参数:

key - 属性 Key，不允许为 null 或空

value - 属性 Value，不允许为 null 或空

抛出:

java.lang.IllegalArgumentException - 如果 key 或 value 为 null 或空，将会抛出此异常

buildMysqlPacketBytes

public byte[] buildMysqlPacketBytes(long serverCapabilitiesFlags)
                             throws java.lang.IllegalArgumentException,
                                    java.lang.IllegalStateException

根据当前 HandshakeResponse41Packet 实例信息，生成对应的 Mysql "HandshakeResponse41Packet" 数据包字节数组， "HandshakeResponse41Packet" 数据包格式定义： Protocol::HandshakeResponse41

注意：调用该方法后，capabilitiesFlags 将会被重新赋值，默认特性将被开启，已指定开启但 Mysql 服务端不支持的特性将会被关闭。

返回:

"HandshakeResponse41Packet" 数据包字节数组

抛出:

java.lang.IllegalArgumentException - 如果 HandshakeResponse41Packet 中关键字段信息尚未设置，将会抛出此异常

java.lang.IllegalStateException - 如果指定的 Mysql 客户端特性在 Mysql 服务端未启用，将会抛出此异常

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object