Package org.forgerock.opendj.ldap.messages

Interface StartTlsExtendedRequest

All Superinterfaces:

ExtendedRequest<ExtendedResult>, ProtocolOp, Request

public interface StartTlsExtendedRequest
extends ExtendedRequest<ExtendedResult>

The start TLS extended request as defined in RFC 4511. The Start Transport Layer Security (StartTLS) operation's purpose is to initiate installation of a TLS layer.

Use an SslOptions 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.

See Also:

RFC 4511 - Lightweight Directory Access Protocol (LDAP): The Protocol

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.opendj.ldap.messages.Request

Request.RequestType

Field Summary

Fields

Modifier and Type	Field	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.

Method Summary

Modifier and Type	Method	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> C	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.

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl

Methods inherited from interface org.forgerock.opendj.ldap.messages.Request

accept, getType

Field Detail

DECODER

static final ExtendedRequestDecoder<StartTlsExtendedRequest,ExtendedResult> DECODER

A decoder which can be used to decode start TLS extended operation requests.

OID

static final String OID

The OID for the start TLS extended operation request.

See Also:

Constant Field Values

Method Detail

addControl

StartTlsExtendedRequest addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ExtendedRequest<ExtendedResult>

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

StartTlsExtendedRequest addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ExtendedRequest<ExtendedResult>

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Request

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

getControl

<C extends Control> C getControl(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException

Description copied from interface: ProtocolOp

Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface ExtendedRequest<ExtendedResult>

Specified by:

getControl in interface ProtocolOp

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

Throws:

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).

getControls

List<Control> getControls()

Description copied from interface: ProtocolOp

Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.

Specified by:

getControls in interface ExtendedRequest<ExtendedResult>

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.

getOid

String getOid()

Description copied from interface: ExtendedRequest

Returns the numeric OID associated with this extended request.

Specified by:

getOid in interface ExtendedRequest<ExtendedResult>

Returns:

The numeric OID associated with this extended request.

getResultDecoder

ExtendedResultDecoder<ExtendedResult> getResultDecoder()

Description copied from interface: ExtendedRequest

Returns a decoder which can be used to decoded responses to this extended request.

Specified by:

getResultDecoder in interface ExtendedRequest<ExtendedResult>

Returns:

A decoder which can be used to decoded responses to this extended request.

getSslOptions

SslOptions getSslOptions()

Returns the SslOptions that should be used when installing the TLS layer. This is only used client-side when interacting with a remove server using a Connection. In a server context, it always returns null.

Returns:

The SslOptions that should be used when installing the TLS layer or null if this is invoked in a server context.

getValue

ByteString getValue()

Description copied from interface: ExtendedRequest

Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.

Specified by:

getValue in interface ExtendedRequest<ExtendedResult>

Returns:

The value associated with this extended request, or null if there is no value.

hasValue

boolean hasValue()

Description copied from interface: ExtendedRequest

Returns 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.

Specified by:

hasValue in interface ExtendedRequest<ExtendedResult>

Returns:

true if this extended request has a value, or false if there is no value.

setSslOptions

StartTlsExtendedRequest setSslOptions(SslOptions sslOptions)

Sets the SslOptions that should be used when installing the TLS layer. This is only used client-side when interacting with a remove server using a Connection. In a server context, the sslOptions will be ignored.

Parameters:

sslOptions - The SslOptions that should be used when installing the TLS layer.

Returns:

This startTLS request.