程序包 com.mysql.cj.protocol

接口 AuthenticationPlugin<M extends Message>

    • 方法概要

      所有方法 实例方法 抽象方法 默认方法 
      修饰符和类型 方法 说明
      default 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 client-side name that the MySQL server uses on the wire for this plugin.
      default void init​(Protocol<M> protocol)
      We need direct Protocol reference because it isn't available from Connection before authentication complete.
      default void init​(Protocol<M> protocol, MysqlCallbackHandler callbackHandler)
      Initializes this plugin with a direct Protocol reference and a generic MysqlCallbackHandler that can be used to pass over information back to the authentication provider.
      boolean isReusable()  
      boolean nextAuthenticationStep​(M fromServer, List<M> 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.
      default void reset()
      Resets the authentication steps sequence.
      void setAuthenticationParameters​(String user, String password)
      This method called from Connector/J before first nextAuthenticationStep call.
      default void setSourceOfAuthData​(String sourceOfAuthData)
      Connector/J uses this method to identify the source of the authentication data, as an authentication plugin name, that will be available to the next authentication step(s).

    • 方法详细资料

      • init

        default void init​(Protocol<M> protocol)
        We need direct Protocol reference because it isn't available from Connection before authentication complete.
        参数:
        protocol - protocol instance

      • init

        default void init​(Protocol<M> protocol,
                  MysqlCallbackHandler callbackHandler)
        Initializes this plugin with a direct Protocol reference and a generic MysqlCallbackHandler that can be used to pass over information back to the authentication provider. For example an authentication plugin may accept null usernames and use that information to obtain them from some external source, such as the system login.
        参数:
        protocol - the protocol instance
        callbackHandler - a callback handler to provide additional information to the authentication provider

      • reset

        default void reset()
        Resets the authentication steps sequence.

      • destroy

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

      • getProtocolPluginName

        String getProtocolPluginName()
        Returns the client-side name that the MySQL server uses on the wire for this plugin.
        返回:
        plugin name

      • requiresConfidentiality

        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.
        返回:
        true if secure connection is required

      • isReusable

        boolean isReusable()
        返回:
        true if plugin instance may be reused, false otherwise

      • setAuthenticationParameters

        void setAuthenticationParameters​(String user,
                                 String password)
        This method called from Connector/J before first nextAuthenticationStep call. Values of user and password parameters are passed from those in NativeAuthenticationProvider#changeUser() or NativeAuthenticationProvider#connect(). 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.
        参数:
        user - user name
        password - user password

      • setSourceOfAuthData

        default void setSourceOfAuthData​(String sourceOfAuthData)
        Connector/J uses this method to identify the source of the authentication data, as an authentication plugin name, that will be available to the next authentication step(s). The source of the authentication data in the first iteration will always be the sever-side default authentication plugin name. In the following iterations this depends on the client-side default authentication plugin or on the successive Protocol::AuthSwitchRequest that may have been received in the meantime. Authentication plugin implementation can use this information to decide if the data coming from the server is useful to them or not.
        参数:
        sourceOfAuthData -

      • nextAuthenticationStep

        boolean nextAuthenticationStep​(M fromServer,
                               List<M> toServer)
        Process authentication handshake data from server and optionally produce data to be sent back to the server. The driver will keep calling this method on each new server packet arrival until either an Exception is thrown (authentication failure, please use appropriate SQLStates) or the number of exchange iterations exceeded max limit or an OK packet is sent by server indicating that the connection has been approved. If, on return from this method, toServer is a non-empty list of buffers, then these buffers will be sent to the server in the same order and without any reads in between them. If toServer is an empty list, no data will be sent to server, driver immediately reads the next packet from server. In case of errors the method should throw Exception.
        参数:
        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).
        返回:
        return value is ignored.