com.mysql.cj.sasl

Class ScramShaSaslClientFactory

java.lang.Object

com.mysql.cj.sasl.ScramShaSaslClientFactory

All Implemented Interfaces:

javax.security.sasl.SaslClientFactory

public class ScramShaSaslClientFactory
extends java.lang.Object
implements javax.security.sasl.SaslClientFactory

A SaslClientFactory for ScramSha1SaslClient and ScramSha256SaslClient instances.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	SUPPORTED_MECHANISMS

Constructor Summary

Constructors

Constructor and Description
ScramShaSaslClientFactory()

Method Summary

Modifier and Type	Method and Description
javax.security.sasl.SaslClient	createSaslClient(java.lang.String[] mechanisms, java.lang.String authorizationId, java.lang.String protocol, java.lang.String serverName, java.util.Map<java.lang.String,?> props, javax.security.auth.callback.CallbackHandler cbh)
java.lang.String[]	getMechanismNames(java.util.Map<java.lang.String,?> props)
private java.lang.String	getPassword(java.lang.String prefix, javax.security.auth.callback.CallbackHandler cbh) Gets the password, which is provided by a CallbackHandler to be implemented by the requester of this service.
private java.lang.String	getUsername(java.lang.String prefix, java.lang.String authorizationId, javax.security.auth.callback.CallbackHandler cbh) Gets the authentication id, which is provided by a CallbackHandler to be implemented by the requester of this service.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_MECHANISMS

private static final java.lang.String[] SUPPORTED_MECHANISMS

Constructor Detail

ScramShaSaslClientFactory

public ScramShaSaslClientFactory()

Method Detail

createSaslClient

public javax.security.sasl.SaslClient createSaslClient(java.lang.String[] mechanisms,
                                                       java.lang.String authorizationId,
                                                       java.lang.String protocol,
                                                       java.lang.String serverName,
                                                       java.util.Map<java.lang.String,?> props,
                                                       javax.security.auth.callback.CallbackHandler cbh)
                                                throws javax.security.sasl.SaslException

Specified by:

createSaslClient in interface javax.security.sasl.SaslClientFactory

Throws:

javax.security.sasl.SaslException

getMechanismNames

public java.lang.String[] getMechanismNames(java.util.Map<java.lang.String,?> props)

Specified by:

getMechanismNames in interface javax.security.sasl.SaslClientFactory

getUsername

private java.lang.String getUsername(java.lang.String prefix,
                                     java.lang.String authorizationId,
                                     javax.security.auth.callback.CallbackHandler cbh)
                              throws javax.security.sasl.SaslException

Gets the authentication id, which is provided by a CallbackHandler to be implemented by the requester of this service.

Parameters:

prefix - the prefix to use in the prompt.

authorizationId - the authorization id that can be used as default authentication id if none is provided.

cbh - the callback handler to use.

Returns:

an authentication id

Throws:

javax.security.sasl.SaslException - if the callback handler is null or not supported by the callback handler implementer.

getPassword

private java.lang.String getPassword(java.lang.String prefix,
                                     javax.security.auth.callback.CallbackHandler cbh)
                              throws javax.security.sasl.SaslException

Gets the password, which is provided by a CallbackHandler to be implemented by the requester of this service.

Parameters:

prefix - the prefix to use in the prompt.

cbh - the callback handler to use.

Returns:

a password

Throws:

javax.security.sasl.SaslException - if the callback handler is null or not supported by the callback handler implementer.