Brand

Ruby Driver for Apache Cassandra

Attention: Viewing documentation for version
(Earlier version)
Download

abstractclass Cassandra::Auth::Authenticator

An authenticator handles the authentication challenge/response cycles of a single connection. It can be stateful, but it must not for any reason block. If any of the method calls block, the whole connection process will be blocked.

Abstract
Authenticators created by auth providers don’t need to be subclasses of this class, but need to implement the same methods. This class exists only for documentation purposes.
See Also:

Inherits

Object

Methods

initial_response

This method must return the initial authentication token to be sent to the server.

Note
This method must absolutely not block.
Returns:
Type Details
String the initial authentication token

challenge_response

(token)

If the authentication requires multiple challenge/response cycles this method will be called when a challenge is returned by the server. A response token must be created and will be sent back to the server.

Note
This method must absolutely not block.
Parameters:
Name Type Details
token String a challenge token sent by the server
Returns:
Type Details
String the authentication token to send back to the server

authentication_successful

(token)

Called when the authentication is successful.

Note
This method must absolutely not block.
Void
Return value of this method is ignored.
Parameters:
Name Type Details
token String a token sent by the server