StartTlsRequest/StartTlsResponse are used to establish
a TLS connection over the existing LDAP connection associated with
the JNDI context on which extendedOperation() is invoked.
Typically, a JNDI program uses these classes as follows.
import javax.naming.ldap.*;
// Open an LDAP association
LdapContext ctx = new InitialLdapContext();
// Perform a StartTLS extended operation
StartTlsResponse tls =
(StartTlsResponse) ctx.extendedOperation(new StartTlsRequest());
// Open a TLS connection (over the existing LDAP association) and get details
// of the negotiated TLS session: cipher suite, peer certificate, etc.
SSLSession session = tls.negotiate();
// ... use ctx to perform protected LDAP operations
// Close the TLS connection (revert back to the underlying LDAP association)
tls.close();
// ... use ctx to perform unprotected LDAP operations
// Close the LDAP association
ctx.close;
StartTlsResponse
| Modifier and Type | Field and Description |
|---|---|
| public static final String | OID
The StartTLS extended request's assigned object identifier is 1.3.6.1.4.1.1466.20037. |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public ExtendedResponse | Returns: The StartTLS extended response object.The object identifier of the extended response.
Its value must be "1.3.6.1.4.1.1466.20037" or null.
Both values are equivalent. id, byte[] The possibly null ASN.1 BER encoded value of the
extended response. This is the raw BER bytes
including the tag and length of the response value.
It does not include the response OID.
Its value is ignored because a Start TLS response
is not expected to contain any response value. berValue, int The starting position in berValue of the bytes to use.
Its value is ignored because a Start TLS response
is not expected to contain any response value. offset, int The number of bytes in berValue to use.
Its value is ignored because a Start TLS response
is not expected to contain any response value. length)Implements javax. Creates an extended response object that corresponds to the LDAP StartTLS extended request. |
| public byte[] | Returns: The null value.Implements javax. Retrieves the StartTLS request's ASN.1 BER encoded value. |
| public String | Returns: The object identifier string, "1.3.6.1.4.1.1466.20037".Implements javax. Retrieves the StartTLS request's object identifier string. |
| private ConfigurationException |
| OID | back to summary |
|---|---|
| public static final String OID The StartTLS extended request's assigned object identifier is 1.3.6.1.4.1.1466.20037. | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| StartTlsRequest | back to summary |
|---|---|
| public StartTlsRequest() Constructs a StartTLS extended request. | |
| createExtendedResponse | back to summary |
|---|---|
| public ExtendedResponse createExtendedResponse(String id, byte[] berValue, int offset, int length) throws NamingException Implements javax. Creates an extended response object that corresponds to the LDAP StartTLS extended request. The result must be a concrete subclass of StartTlsResponse and must have a public zero-argument constructor. This method locates the implementation class by locating configuration files that have the name:
Each configuration file should contain a list of fully-qualified class
names, one per line. Space and tab characters surrounding each name, as
well as blank lines, are ignored. The comment character is This method will return an instance of the first implementation class that it is able to load and instantiate successfully from the list of class names collected from the configuration files. This method uses the calling thread's context classloader to find the configuration files and to load the implementation class. If no class can be found in this way, this method will use an implementation-specific way to locate an implementation. If none is found, a NamingException is thrown.
| |
| getEncodedValue | back to summary |
|---|---|
| public byte[] getEncodedValue() Implements javax. Retrieves the StartTLS request's ASN.1 BER encoded value. Since the request has no defined value, null is always returned.
| |
| getID | back to summary |
|---|---|
| public String getID() Implements javax. Retrieves the StartTLS request's object identifier string.
| |
| wrapException | back to summary |
|---|---|
| private ConfigurationException wrapException(Exception e) | |