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...
Request.RequestType
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 protocol-op.
|
StartTlsExtendedRequest |
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this protocol-op having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
protocol-op. |
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.
|
SslOptions |
getSslOptions()
Returns the SslOptions 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 |
setSslOptions(SslOptions sslOptions)
Sets the SslOptions that should be used when installing the TLS layer.
|
containsControl
static final ExtendedRequestDecoder<StartTlsExtendedRequest,ExtendedResult> DECODER
static final String OID
StartTlsExtendedRequest addControl(Control control)
ProtocolOp
addControl
in interface ExtendedRequest<ExtendedResult>
addControl
in interface ProtocolOp
addControl
in interface Request
control
- The control to be added to this protocol-op.StartTlsExtendedRequest addControls(Iterable<? extends Control> controls)
ProtocolOp
addControls
in interface ExtendedRequest<ExtendedResult>
addControls
in interface ProtocolOp
addControls
in interface Request
controls
- The controls to be added to this protocol-op.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ProtocolOp
getControl
in interface ExtendedRequest<ExtendedResult>
getControl
in interface ProtocolOp
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 protocol-op.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()
ProtocolOp
List
containing the controls included with this
protocol-op. The returned List
may be modified if permitted by this
protocol-op.getControls
in interface ExtendedRequest<ExtendedResult>
getControls
in interface ProtocolOp
List
containing the controls.String getOid()
ExtendedRequest
getOid
in interface ExtendedRequest<ExtendedResult>
ExtendedResultDecoder<ExtendedResult> getResultDecoder()
ExtendedRequest
getResultDecoder
in interface ExtendedRequest<ExtendedResult>
SslOptions getSslOptions()
null
.null
if this is invoked in a server context.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 setSslOptions(SslOptions sslOptions)
sslOptions
- The SslOptions that should be used when installing the TLS
layer.Copyright 2010-2018 ForgeRock AS.