javax.naming.ldap

Class StartTlsResponse

java.lang.Object

javax.naming.ldap.StartTlsResponse

All Implemented Interfaces:

java.io.Serializable, ExtendedResponse

public abstract class StartTlsResponse
extends java.lang.Object
implements ExtendedResponse

Since:

1.4

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OID The assigned object identifier for this response.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StartTlsResponse() Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Close the connection.
byte[]	getEncodedValue() Return the encoded value.
java.lang.String	getID() Return the response identifier.
abstract javax.net.ssl.SSLSession	negotiate() Negotiate the TLS session using the default SSL socket factory.
abstract javax.net.ssl.SSLSession	negotiate(javax.net.ssl.SSLSocketFactory factory) Negotiate the TLS session using the supplied SSL socket factory.
abstract void	setEnabledCipherSuites(java.lang.String[] cipherSuites) Set the list of cipher suites to use.
abstract void	setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier) Set the hostname verifier to use.

Methods inherited from class java.lang.Object

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

Field Detail

OID

public static final java.lang.String OID

The assigned object identifier for this response.

See Also:

Constant Field Values

Constructor Detail

StartTlsResponse

protected StartTlsResponse()

Create a new instance.

Method Detail

getID

public java.lang.String getID()

Return the response identifier. This is simply the value of the OID field.

Specified by:

getID in interface ExtendedResponse

getEncodedValue

public byte[] getEncodedValue()

Return the encoded value. This implementation always returns null.

Specified by:

getEncodedValue in interface ExtendedResponse

setEnabledCipherSuites

public abstract void setEnabledCipherSuites(java.lang.String[] cipherSuites)

Set the list of cipher suites to use.

Parameters:

cipherSuites - the list of suites

See Also:

SSLSocketFactory.getSupportedCipherSuites()

setHostnameVerifier

public abstract void setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)

Set the hostname verifier to use. This must be called before negotiate().

Parameters:

verifier - the hostname verifier

negotiate

public abstract javax.net.ssl.SSLSession negotiate()
                                            throws java.io.IOException

Negotiate the TLS session using the default SSL socket factory.

Returns:

the SSL session

Throws:

java.io.IOException - if communication fails for some reason

negotiate

public abstract javax.net.ssl.SSLSession negotiate(javax.net.ssl.SSLSocketFactory factory)
                                            throws java.io.IOException

Negotiate the TLS session using the supplied SSL socket factory.

Parameters:

factory - the socket factory to use

Returns:

the SSL session

Throws:

java.io.IOException - if communication fails for some reason

close

public abstract void close()
                    throws java.io.IOException

Close the connection.

Throws:

java.io.IOException - if communication fails for some reason