OpenJDK 27 · com.sun.jndi.ldap.sasl.LdapSasl · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final String	CHANNEL_BINDING
private static final String	CHANNEL_BINDING_TYPE
private static final int	LDAP_SASL_BIND_IN_PROGRESS
private static final int	LDAP_SUCCESS
private static final byte[]	NO_BYTES
private static final String	SASL_AUTHZ_ID
private static final String	SASL_CALLBACK
private static final String	SASL_REALM

Constructor Summary

Access	Constructor and Description
private	LdapSasl()

Method Summary

Modifier and Type	Method and Description
private static String[]	Returns: A non-null array of String; each element of the array contains a single mechanism name. getSaslMechanismNames(String str) Returns an array of SASL mechanisms given a string of space separated SASL mechanism names.
public static LdapResult	Returns: LdapResult containing status of the bind saslBind(LdapClient clnt, Connection The non-null connection to use for sending an LDAP BIND conn, String Non-null string name of host to connect to server, String Non-null DN to bind as; also used as authentication ID dn, Object Possibly null password; can be byte[], char[] or String pw, String A non-null space-separated list of SASL authentication mechanisms. authMech, Hashtable<?, ?> The possibly null environment of the context, possibly containing properties for used by SASL mechanisms env, Control[] The possibly null controls to accompany the bind bindCtls) Performs SASL bind.
private static NamingException	wrapInNamingException(Exception e)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHANNEL_BINDING	back to summary
private static final String CHANNEL_BINDING

CHANNEL_BINDING_TYPE	back to summary
private static final String CHANNEL_BINDING_TYPE

LDAP_SASL_BIND_IN_PROGRESS	back to summary
private static final int LDAP_SASL_BIND_IN_PROGRESS

LDAP_SUCCESS	back to summary
private static final int LDAP_SUCCESS

NO_BYTES	back to summary
private static final byte[] NO_BYTES

SASL_AUTHZ_ID	back to summary
private static final String SASL_AUTHZ_ID

SASL_CALLBACK	back to summary
private static final String SASL_CALLBACK

SASL_REALM	back to summary
private static final String SASL_REALM

Constructor Detail

LdapSasl	back to summary
private LdapSasl()

Method Detail

getSaslMechanismNames	back to summary
private static String[] getSaslMechanismNames(String str) Returns an array of SASL mechanisms given a string of space separated SASL mechanism names. Returns:String[] A non-null array of String; each element of the array contains a single mechanism name.

getSaslMechanismNames

back to summary

private static String[] getSaslMechanismNames(String str)

Returns an array of SASL mechanisms given a string of space separated SASL mechanism names.

Returns:String[]: A non-null array of String; each element of the array contains a single mechanism name.

saslBind	back to summary
public static LdapResult saslBind(LdapClient clnt, Connection conn, String server, String dn, Object pw, String authMech, Hashtable<?, ?> env, Control[] bindCtls) throws IOException, NamingException Performs SASL bind. Creates a SaslClient by using a default CallbackHandler that uses the Context.SECURITY_PRINCIPAL and Context.SECURITY_CREDENTIALS properties to satisfy the callbacks, and by using the SASL_AUTHZ_ID property as the authorization id. If the SASL_AUTHZ_ID property has not been set, Context.SECURITY_PRINCIPAL is used. If SASL_CALLBACK has been set, use that instead of the default CallbackHandler. If bind is successful and the selected SASL mechanism has a security layer, set inStream and outStream to be filter streams that use the security layer. These will be used for subsequent communication with the server. Parameters conn:Connection The non-null connection to use for sending an LDAP BIND server:String Non-null string name of host to connect to dn:String Non-null DN to bind as; also used as authentication ID pw:Object Possibly null password; can be byte[], char[] or String authMech:String A non-null space-separated list of SASL authentication mechanisms. env:Hashtable<?, ?> The possibly null environment of the context, possibly containing properties for used by SASL mechanisms bindCtls:Control[] The possibly null controls to accompany the bind Returns:LdapResult LdapResult containing status of the bind Annotations @SuppressWarnings:unchecked

saslBind

back to summary

public static LdapResult saslBind(LdapClient clnt, Connection conn, String server, String dn, Object pw, String authMech, Hashtable<?, ?> env, Control[] bindCtls) throws IOException, NamingException

Performs SASL bind. Creates a SaslClient by using a default CallbackHandler that uses the Context.SECURITY_PRINCIPAL and Context.SECURITY_CREDENTIALS properties to satisfy the callbacks, and by using the SASL_AUTHZ_ID property as the authorization id. If the SASL_AUTHZ_ID property has not been set, Context.SECURITY_PRINCIPAL is used. If SASL_CALLBACK has been set, use that instead of the default CallbackHandler.

If bind is successful and the selected SASL mechanism has a security layer, set inStream and outStream to be filter streams that use the security layer. These will be used for subsequent communication with the server.

Parameters

conn:Connection: The non-null connection to use for sending an LDAP BIND
server:String: Non-null string name of host to connect to
dn:String: Non-null DN to bind as; also used as authentication ID
pw:Object: Possibly null password; can be byte[], char[] or String
authMech:String: A non-null space-separated list of SASL authentication mechanisms.
env:Hashtable<?, ?>: The possibly null environment of the context, possibly containing properties for used by SASL mechanisms
bindCtls:Control[]: The possibly null controls to accompany the bind

Returns:LdapResult

LdapResult containing status of the bind

Annotations

@SuppressWarnings:unchecked