OpenJDK 27 · com.sun.jndi.ldap.ext.StartTlsResponseImpl

Modifier and Type	Field and Description
private transient boolean	closed
private transient SSLSocketFactory	currentFactory
private static final boolean	debug
private transient SSLSocketFactory	defaultFactory
private transient String	hostname
private transient Connection	ldapConnection
private transient InputStream	originalInputStream
private transient OutputStream	originalOutputStream
private static final long	serialVersionUID Hides javax.naming.ldap.StartTlsResponse.serialVersionUID.
private transient SSLSocket	sslSocket
private transient String[]	suites
private transient HostnameVerifier	verifier

Access	Constructor and Description
public	StartTlsResponseImpl()

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract javax.naming.ldap.StartTlsResponse.close. Closes the TLS connection gracefully and reverts back to the underlying connection.
private SSLSocketFactory	getDefaultFactory()
public SSLSession	Returns: The negotiated SSL session negotiate() Implements abstract javax.naming.ldap.StartTlsResponse.negotiate. Negotiates a TLS session using the default SSL socket factory.
public SSLSession	Returns: The negotiated SSL session negotiate(SSLSocketFactory The possibly null SSL socket factory to use. If null, the default SSL socket factory is used. factory) Implements abstract javax.naming.ldap.StartTlsResponse.negotiate. Negotiates a TLS session using an SSL socket factory.
public void	setConnection(Connection The non-null connection to use. ldapConnection, String The server's hostname. If null, the hostname used to open the connection will be used instead. hostname) Sets the connection for TLS to use.
public void	setEnabledCipherSuites(String[] The non-null list of names of all the cipher suites to enable. suites) Implements abstract javax.naming.ldap.StartTlsResponse.setEnabledCipherSuites. Overrides the default list of cipher suites enabled for use on the TLS connection.
public void	setHostnameVerifier(HostnameVerifier The non-null hostname verifier callback. verifier) Implements abstract javax.naming.ldap.StartTlsResponse.setHostnameVerifier. Overrides the default hostname verifier used by `negotiate()` after the TLS handshake has completed.
private SSLSocket	startHandshake(SSLSocketFactory factory)
private boolean	verify(String hostname, SSLSession session)

Inherited from javax.naming.ldap.StartTlsResponse:: getEncodedValue getID

closed	back to summary
private transient boolean closed

currentFactory	back to summary
private transient SSLSocketFactory currentFactory

debug	back to summary
private static final boolean debug

defaultFactory	back to summary
private transient SSLSocketFactory defaultFactory

hostname	back to summary
private transient String hostname

ldapConnection	back to summary
private transient Connection ldapConnection

originalInputStream	back to summary
private transient InputStream originalInputStream

originalOutputStream	back to summary
private transient OutputStream originalOutputStream

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.naming.ldap.StartTlsResponse.serialVersionUID.

sslSocket	back to summary
private transient SSLSocket sslSocket

suites	back to summary
private transient String[] suites

verifier	back to summary
private transient HostnameVerifier verifier

StartTlsResponseImpl	back to summary
public StartTlsResponseImpl()

Method Detail

close	back to summary
public void close() throws IOException Implements abstract javax.naming.ldap.StartTlsResponse.close. Closes the TLS connection gracefully and reverts back to the underlying connection. Annotations @Override Exceptions IOException: If an IO error was encountered while closing the TLS connection

back to summary

public void close() throws IOException

Implements abstract javax.naming.ldap.StartTlsResponse.close.

Closes the TLS connection gracefully and reverts back to the underlying connection.

Annotations

@Override

Exceptions

IOException:: If an IO error was encountered while closing the TLS connection

getDefaultFactory	back to summary
private SSLSocketFactory getDefaultFactory()

negotiate back to summary

negotiate	back to summary
public SSLSession negotiate() throws IOException Implements abstract javax.naming.ldap.StartTlsResponse.negotiate. Negotiates a TLS session using the default SSL socket factory. This method is equivalent to `negotiate(null)`. Returns:SSLSession The negotiated SSL session Annotations @Override Exceptions IOException: If an IO error was encountered while establishing the TLS session. See Also `setEnabledCipherSuites`, `setHostnameVerifier`

public SSLSession negotiate() throws IOException

Implements abstract javax.naming.ldap.StartTlsResponse.negotiate.

Negotiates a TLS session using the default SSL socket factory.

This method is equivalent to negotiate(null).

Returns:SSLSession

The negotiated SSL session

Annotations

@Override

Exceptions

IOException:: If an IO error was encountered while establishing the TLS session.

negotiate back to summary

negotiate	back to summary
public SSLSession negotiate(SSLSocketFactory factory) throws IOException Implements abstract javax.naming.ldap.StartTlsResponse.negotiate. Negotiates a TLS session using an SSL socket factory. Creates an SSL socket using the supplied SSL socket factory and attaches it to the existing connection. Performs the TLS handshake and returns the negotiated session information. If cipher suites have been set via `setEnabledCipherSuites` then they are enabled before the TLS handshake begins. Hostname verification is performed after the TLS handshake completes. The default check performs a case insensitive match of the server's hostname against that in the server's certificate. The server's hostname is extracted from the subjectAltName in the server's certificate (if present). Otherwise the value of the common name attribute of the subject name is used. If a callback has been set via `setHostnameVerifier` then that verifier is used if the default check fails. If an error occurs then the SSL socket is closed and an IOException is thrown. The underlying connection remains intact. Parameters factory:SSLSocketFactory The possibly null SSL socket factory to use. If null, the default SSL socket factory is used. Returns:SSLSession The negotiated SSL session Annotations @Override Exceptions IOException: If an IO error was encountered while establishing the TLS session. See Also `setEnabledCipherSuites`, `setHostnameVerifier`

public SSLSession negotiate(SSLSocketFactory factory) throws IOException

Implements abstract javax.naming.ldap.StartTlsResponse.negotiate.

Negotiates a TLS session using an SSL socket factory.

Creates an SSL socket using the supplied SSL socket factory and attaches it to the existing connection. Performs the TLS handshake and returns the negotiated session information.

If cipher suites have been set via setEnabledCipherSuites then they are enabled before the TLS handshake begins.

Hostname verification is performed after the TLS handshake completes. The default check performs a case insensitive match of the server's hostname against that in the server's certificate. The server's hostname is extracted from the subjectAltName in the server's certificate (if present). Otherwise the value of the common name attribute of the subject name is used. If a callback has been set via setHostnameVerifier then that verifier is used if the default check fails.

If an error occurs then the SSL socket is closed and an IOException is thrown. The underlying connection remains intact.

Parameters

factory:SSLSocketFactory: The possibly null SSL socket factory to use. If null, the default SSL socket factory is used.

Returns:SSLSession

The negotiated SSL session

Annotations

@Override

Exceptions

IOException:: If an IO error was encountered while establishing the TLS session.

setConnection	back to summary
public void setConnection(Connection ldapConnection, String hostname) Sets the connection for TLS to use. The TLS connection will be attached to this connection. Parameters ldapConnection:Connection The non-null connection to use. hostname:String The server's hostname. If null, the hostname used to open the connection will be used instead.

setConnection

back to summary

public void setConnection(Connection ldapConnection, String hostname)

Sets the connection for TLS to use. The TLS connection will be attached to this connection.

Parameters

ldapConnection:Connection: The non-null connection to use.
hostname:String: The server's hostname. If null, the hostname used to open the connection will be used instead.

setEnabledCipherSuites back to summary

setEnabledCipherSuites	back to summary
public void setEnabledCipherSuites(String[] suites) Implements abstract javax.naming.ldap.StartTlsResponse.setEnabledCipherSuites. Overrides the default list of cipher suites enabled for use on the TLS connection. The cipher suites must have already been listed by `SSLSocketFactory.getSupportedCipherSuites()` as being supported. Even if a suite has been enabled, it still might not be used because the peer does not support it, or because the requisite certificates (and private keys) are not available. Parameters suites:String[] The non-null list of names of all the cipher suites to enable. Annotations @Override See Also `negotiate`

public void setEnabledCipherSuites(String[] suites)

Implements abstract javax.naming.ldap.StartTlsResponse.setEnabledCipherSuites.

Overrides the default list of cipher suites enabled for use on the TLS connection. The cipher suites must have already been listed by SSLSocketFactory.getSupportedCipherSuites() as being supported. Even if a suite has been enabled, it still might not be used because the peer does not support it, or because the requisite certificates (and private keys) are not available.

Parameters

suites:String[]: The non-null list of names of all the cipher suites to enable.

Annotations

@Override

See Also

negotiate

setHostnameVerifier back to summary

setHostnameVerifier	back to summary
public void setHostnameVerifier(HostnameVerifier verifier) Implements abstract javax.naming.ldap.StartTlsResponse.setHostnameVerifier. Overrides the default hostname verifier used by `negotiate()` after the TLS handshake has completed. If `setHostnameVerifier()` has not been called before `negotiate()` is invoked, `negotiate()` will perform a simple case ignore match. If called after `negotiate()`, this method does not do anything. Parameters verifier:HostnameVerifier The non-null hostname verifier callback. Annotations @Override See Also `negotiate`

public void setHostnameVerifier(HostnameVerifier verifier)

Implements abstract javax.naming.ldap.StartTlsResponse.setHostnameVerifier.

Overrides the default hostname verifier used by negotiate() after the TLS handshake has completed. If setHostnameVerifier() has not been called before negotiate() is invoked, negotiate() will perform a simple case ignore match. If called after negotiate(), this method does not do anything.

Parameters

verifier:HostnameVerifier: The non-null hostname verifier callback.

Annotations

@Override

See Also

negotiate

startHandshake	back to summary
private SSLSocket startHandshake(SSLSocketFactory factory) throws IOException

verify	back to summary
private boolean verify(String hostname, SSLSession session) throws SSLPeerUnverifiedException

public final Class StartTlsResponseImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail