程序包 com.mysql.cj.protocol.a.authentication

类 MysqlClearPasswordPlugin

java.lang.Object

com.mysql.cj.protocol.a.authentication.MysqlClearPasswordPlugin

所有已实现的接口:

AuthenticationPlugin<NativePacketPayload>

public class MysqlClearPasswordPlugin
extends Object
implements AuthenticationPlugin<NativePacketPayload>

MySQL Clear Password Authentication Plugin

构造器概要

构造器

构造器	说明
MysqlClearPasswordPlugin()

方法概要

修饰符和类型	方法	说明
void	destroy()	Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed.
String	getProtocolPluginName()	Returns the name that the MySQL server uses on the wire for this plugin
void	init(Protocol<NativePacketPayload> prot)	We need direct Protocol reference because it isn't available from Connection before authentication complete.
boolean	isReusable()
boolean	nextAuthenticationStep(NativePacketPayload fromServer, List<NativePacketPayload> toServer)	Process authentication handshake data from server and optionally produce data to be sent back to the server.
boolean	requiresConfidentiality()	Does this plugin require the connection itself to be confidential (i.e. tls/ssl)...Highly recommended to return "true" for plugins that return the credentials in the clear.
void	setAuthenticationParameters(String user, String password)	This method called from cJ before first nextAuthenticationStep call.

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

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

从接口继承的方法 com.mysql.cj.protocol.AuthenticationPlugin

reset

构造器详细资料

MysqlClearPasswordPlugin

public MysqlClearPasswordPlugin()

方法详细资料

init

public void init(Protocol<NativePacketPayload> prot)

从接口复制的说明: AuthenticationPlugin

We need direct Protocol reference because it isn't available from Connection before authentication complete.

指定者:

init 在接口中 AuthenticationPlugin<NativePacketPayload>

参数:

prot - protocol instance

destroy

public void destroy()

从接口复制的说明: AuthenticationPlugin

Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed.

指定者:

destroy 在接口中 AuthenticationPlugin<NativePacketPayload>

getProtocolPluginName

public String getProtocolPluginName()

从接口复制的说明: AuthenticationPlugin

Returns the name that the MySQL server uses on the wire for this plugin

指定者:

getProtocolPluginName 在接口中 AuthenticationPlugin<NativePacketPayload>

返回:

plugin name

requiresConfidentiality

public boolean requiresConfidentiality()

从接口复制的说明: AuthenticationPlugin

Does this plugin require the connection itself to be confidential (i.e. tls/ssl)...Highly recommended to return "true" for plugins that return the credentials in the clear.

指定者:

requiresConfidentiality 在接口中 AuthenticationPlugin<NativePacketPayload>

返回:

true if secure connection is required

isReusable

public boolean isReusable()

指定者:

isReusable 在接口中 AuthenticationPlugin<NativePacketPayload>

返回:

true if plugin instance may be reused, false otherwise

setAuthenticationParameters

public void setAuthenticationParameters(String user,
                                        String password)

从接口复制的说明: AuthenticationPlugin

This method called from cJ before first nextAuthenticationStep call. Values of user and password parameters are passed from those in MysqlIO.changeUser(String userName, String password, String database) or MysqlIO.doHandshake(String user, String password, String database). Plugin should use these values instead of values from connection properties because parent method may be a changeUser call which saves user and password into connection only after successful handshake.

指定者:

setAuthenticationParameters 在接口中 AuthenticationPlugin<NativePacketPayload>

参数:

user - user name

password - user password

nextAuthenticationStep

public boolean nextAuthenticationStep(NativePacketPayload fromServer,
                                      List<NativePacketPayload> toServer)

从接口复制的说明: AuthenticationPlugin

Process authentication handshake data from server and optionally produce data to be sent back to the server. The driver will keep calling this method until either an Exception is thrown (authentication failure, please use appropriate SQLStates) or the method returns false or driver receives an OK packet from the server which indicates that the connection has been already approved. If, on return from this method, toServer is a non-empty list of buffers, then these buffers should be sent to the server in order and without any reads in between them. If toServer is an empty list, no data should be sent to server. If method returns true, it means that this plugin does not need any more data from the server to conclude the handshake and this method should not be called again. (Note that server can send an Auth Method Switch request and then another handshake will start, possibly using a different plugin.) If this method returns false, it means that plugin needs more data from the server to conclude the handshake. In that case next handshake data payload should be read from the server (after possibly writing data from toServer as explained above). Then this method should be called again with the new data in fromServer parameter. In case of errors the method should throw Exception.

指定者:

nextAuthenticationStep 在接口中 AuthenticationPlugin<NativePacketPayload>

参数:

fromServer - a buffer containing handshake data payload from server (can be empty).

toServer - list of buffers with data to be sent to the server (the list can be empty, but buffers in the list should contain data).

返回:

False if more data should be read from the server and next call to this method made, true otherwise.