Class: Cql::Auth::AuthProvider

Inherits:

Object

Object
Cql::Auth::AuthProvider

show all

Defined in:: lib/cql/auth.rb

Overview

Note:

Creating an authenticator must absolutely not block, or the whole connection process will block.

Note:

Auth providers given to Client.connect as the :auth_provider option don't need to be subclasses of this class, but need to implement the same methods. This class exists only for documentation purposes.

An auth provider is a factory for Client::Authenticator instances (or objects matching that interface). Its #create_authenticator will be called once for each connection that requires authentication.

If the authentication requires keeping state, keep that in the authenticator instances, not in the auth provider.