com.instaclustr.cassandra.driver.auth

Class KerberosAuthProviderBase.KerberosAuthOptions.Builder

java.lang.Object

com.instaclustr.cassandra.driver.auth.KerberosAuthProviderBase.KerberosAuthOptions.Builder

Enclosing class:

KerberosAuthProviderBase.KerberosAuthOptions

public static class KerberosAuthProviderBase.KerberosAuthOptions.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
KerberosAuthProviderBase.KerberosAuthOptions	build()
KerberosAuthProviderBase.KerberosAuthOptions.Builder	withAuthorizationId(String authorizationId) Provide an authorization ID, representing a Cassandra user.
KerberosAuthProviderBase.KerberosAuthOptions.Builder	withSaslProperties(Map<String,?> saslProperties) Specify the SASL properties for authentication.
KerberosAuthProviderBase.KerberosAuthOptions.Builder	withSaslProtocol(String saslProtocol) Provide a SASL protocol name.
KerberosAuthProviderBase.KerberosAuthOptions.Builder	withServerNameResolver(ServerNameResolver serverNameResolver) Optional resolver for the serverName as part of the SASL Client API.

Methods inherited from class java.lang.Object

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

Method Detail

withAuthorizationId

public KerberosAuthProviderBase.KerberosAuthOptions.Builder withAuthorizationId(String authorizationId)

Provide an authorization ID, representing a Cassandra user. The user will be assumed on behalf of the client's principal. Note that the client principal must still exist as a Cassandra user, and the user represented by the client's principal must have permission on the user represented by the authorization ID. For example, if the client application connects to a Cassandra cluster using the Kerberos principal admin@EXAMPLE.COM, and an authorization ID of "demoapp", then the authenticator will assume the Cassandra role of "demoapp", assuming that the Cassandra user "admin" exists and has permission on role "demoapp". If not provided, the application will assume the cassandra role represented by the client's principal. See GRANT ROLE for more information.

Parameters:

authorizationId - Username of a Cassandra user to assume

Returns:

the builder object

withSaslProtocol

public KerberosAuthProviderBase.KerberosAuthOptions.Builder withSaslProtocol(String saslProtocol)

Provide a SASL protocol name. The protocol name must match the service principals used by the Cassandra nodes. For example, if the Cassandra nodes are configured to use service principals named cassandra/host1.cluster.example.com@EXAMPLE.COM, then the SASL protocol name is "cassandra". If not provided, the default value of cassandra is used.

Parameters:

saslProtocol - The name of the SASL protocol

Returns:

the builder object

withSaslProperties

public KerberosAuthProviderBase.KerberosAuthOptions.Builder withSaslProperties(Map<String,?> saslProperties)

Specify the SASL properties for authentication. Note that the QOP value must match that configured for the Cassandra nodes. Note that if using Cassandra client TLS, a QOP value other than "auth" will provide redundant encryption/integrity protection over that already provided by TLS. See here for further information.

Parameters:

saslProperties - SASL properties to apply to the connection.

Returns:

the builder object

withServerNameResolver

public KerberosAuthProviderBase.KerberosAuthOptions.Builder withServerNameResolver(ServerNameResolver serverNameResolver)

Optional resolver for the serverName as part of the SASL Client API. Defaults to the IP Addresses Canonical HostName. See here for further information.

Parameters:

serverNameResolver - The optional implementation of a resolver for the serverName

Returns:

the builder object

build

public KerberosAuthProviderBase.KerberosAuthOptions build()