public interface StartTLSExtendedRequest extends ExtendedRequest<ExtendedResult>
Use an SSLContextBuilder
when setting up LDAP options needed to use StartTLS.
TrustManagers
has methods you
can use to set the trust manager for the SSL context builder.
LDAPOptions options = new LDAPOptions(); SSLContext sslContext = new SSLContextBuilder().setTrustManager(...).getSSLContext(); options.setSSLContext(sslContext); options.setUseStartTLS(true); String host = ...; int port = ...; LDAPConnectionFactory factory = new LDAPConnectionFactory(host, port, options); Connection connection = factory.getConnection(); // Connection uses StartTLS...
Modifier and Type | Field and Description |
---|---|
static ExtendedRequestDecoder<StartTLSExtendedRequest,ExtendedResult> |
DECODER
A decoder which can be used to decode start TLS extended operation
requests.
|
static String |
OID
The OID for the start TLS extended operation request.
|
Modifier and Type | Method and Description |
---|---|
StartTLSExtendedRequest |
addControl(Control control)
Adds the provided control to this request.
|
StartTLSExtendedRequest |
addEnabledCipherSuite(Collection<String> suites)
Adds the cipher suites enabled for secure connections with the Directory
Server.
|
StartTLSExtendedRequest |
addEnabledCipherSuite(String... suites)
Adds the cipher suites enabled for secure connections with the Directory
Server.
|
StartTLSExtendedRequest |
addEnabledProtocol(Collection<String> protocols)
Adds the protocol versions enabled for secure connections with the
Directory Server.
|
StartTLSExtendedRequest |
addEnabledProtocol(String... protocols)
Adds the protocol versions enabled for secure connections with the
Directory Server.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
request. |
List<String> |
getEnabledCipherSuites()
Returns the names of the protocol versions which are currently enabled
for secure connections with the Directory Server.
|
List<String> |
getEnabledProtocols()
Returns the names of the protocol versions which are currently enabled
for secure connections with the Directory Server.
|
String |
getOID()
Returns the numeric OID associated with this extended request.
|
ExtendedResultDecoder<ExtendedResult> |
getResultDecoder()
Returns a decoder which can be used to decoded responses to this extended
request.
|
SSLContext |
getSSLContext()
Returns the SSLContext that should be used when installing the TLS layer.
|
ByteString |
getValue()
Returns the value, if any, associated with this extended request.
|
boolean |
hasValue()
Returns
true if this extended request has a value. |
StartTLSExtendedRequest |
setSSLContext(SSLContext sslContext)
Sets the SSLContext that should be used when installing the TLS layer.
|
containsControl
static final ExtendedRequestDecoder<StartTLSExtendedRequest,ExtendedResult> DECODER
static final String OID
StartTLSExtendedRequest addControl(Control control)
Request
addControl
in interface ExtendedRequest<ExtendedResult>
addControl
in interface Request
control
- The control to be added to this request.StartTLSExtendedRequest addEnabledCipherSuite(String... suites)
setSSLContext(SSLContext)
. Following a successful call to this
method, only the suites listed in the protocols parameter are enabled for
use.suites
- Names of all the suites to enable.UnsupportedOperationException
- If this start TLS extended request does not permit the
enabled cipher suites to be set.StartTLSExtendedRequest addEnabledCipherSuite(Collection<String> suites)
setSSLContext(SSLContext)
. Following a successful call to this
method, only the suites listed in the protocols parameter are enabled for
use.suites
- Names of all the suites to enable.UnsupportedOperationException
- If this start TLS extended request does not permit the
enabled cipher suites to be set.StartTLSExtendedRequest addEnabledProtocol(String... protocols)
setSSLContext(SSLContext)
. Following a successful
call to this method, only the protocols listed in the protocols parameter
are enabled for use.protocols
- Names of all the protocols to enable.UnsupportedOperationException
- If this start TLS extended request does not permit the
enabled protocols to be set.StartTLSExtendedRequest addEnabledProtocol(Collection<String> protocols)
setSSLContext(SSLContext)
. Following a successful
call to this method, only the protocols listed in the protocols parameter
are enabled for use.protocols
- Names of all the protocols to enable.UnsupportedOperationException
- If this start TLS extended request does not permit the
enabled protocols to be set.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface ExtendedRequest<ExtendedResult>
getControl
in interface Request
C
- The type of control to be decoded and returned.decoder
- The control decoder.options
- The set of decode options which should be used when decoding
the control.null
if the control is not
included with this request.DecodeException
- If the control could not be decoded because it was malformed
in some way (e.g. the control value was missing, or its
content could not be decoded).List<Control> getControls()
Request
List
containing the controls included with this
request. The returned List
may be modified if permitted by this
request.getControls
in interface ExtendedRequest<ExtendedResult>
getControls
in interface Request
List
containing the controls.List<String> getEnabledCipherSuites()
List<String> getEnabledProtocols()
String getOID()
ExtendedRequest
getOID
in interface ExtendedRequest<ExtendedResult>
ExtendedResultDecoder<ExtendedResult> getResultDecoder()
ExtendedRequest
getResultDecoder
in interface ExtendedRequest<ExtendedResult>
SSLContext getSSLContext()
ByteString getValue()
ExtendedRequest
getValue
in interface ExtendedRequest<ExtendedResult>
null
if there is no value.boolean hasValue()
ExtendedRequest
true
if this extended request has a value. In some
circumstances it may be useful to determine if a extended request has a
value, without actually calculating the value and incurring any
performance costs.hasValue
in interface ExtendedRequest<ExtendedResult>
true
if this extended request has a value, or
false
if there is no value.StartTLSExtendedRequest setSSLContext(SSLContext sslContext)
sslContext
- The SSLContext that should be used when installing the TLS
layer.Copyright 2010-2017 ForgeRock AS.