Uses of Interface
org.forgerock.opendj.ldap.controls.Control

Packages that use Control

Package	Description
org.forgerock.opendj.io	Classes and interfaces providing I/O functionality.
org.forgerock.opendj.ldap.controls	Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.

Uses of Control in org.forgerock.opendj.io

Methods in org.forgerock.opendj.io that return Control

Modifier and Type	Method	Description
static Control	Ldap.readControl(Asn1Reader reader)	Reads the next ASN.1 element from the provided ASN1Reader as a Control.

Uses of Control in org.forgerock.opendj.ldap.controls

Classes in org.forgerock.opendj.ldap.controls with type parameters of type Control

Modifier and Type	Interface	Description
interface	ControlDecoder<C extends Control>	A factory interface for decoding a control as a control of specific type.

Classes in org.forgerock.opendj.ldap.controls that implement Control

Modifier and Type	Class	Description
final class	AdNotificationRequestControl	The persistent search request control for Active Directory as defined by Microsoft.
final class	AssertionRequestControl	The assertion request control as defined in RFC 4528.
final class	AuthorizationIdentityRequestControl	The authorization request control as defined in RFC 3829.
final class	AuthorizationIdentityResponseControl	The authorization response control as defined in RFC 3829.
final class	EntryChangeNotificationResponseControl	The entry change notification response control as defined in draft-ietf-ldapext-psearch.
final class	GenericControl	A generic control which can be used to represent arbitrary raw request and response controls.
final class	GetEffectiveRightsRequestControl	A partial implementation of the get effective rights request control as defined in draft-ietf-ldapext-acl-model.
final class	ManageDsaItRequestControl	The ManageDsaIT request control as defined in RFC 3296.
final class	MatchedValuesRequestControl	The matched values request control as defined in RFC 3876.
final class	PasswordExpiredResponseControl	The Netscape password expired response control as defined in draft-vchu-ldap-pwd-policy.
final class	PasswordExpiringResponseControl	The Netscape password expiring response control as defined in draft-vchu-ldap-pwd-policy.
final class	PasswordPolicyRequestControl	The password policy request control as defined in draft-behera-ldap-password-policy.
final class	PasswordPolicyResponseControl	The password policy response control as defined in draft-behera-ldap-password-policy.
final class	PermissiveModifyRequestControl	The Microsoft defined permissive modify request control.
final class	PersistentSearchRequestControl	The persistent search request control as defined in draft-ietf-ldapext-psearch.
final class	PostReadRequestControl	The post-read request control as defined in RFC 4527.
final class	PostReadResponseControl	The post-read response control as defined in RFC 4527.
final class	PreReadRequestControl	The pre-read request control as defined in RFC 4527.
final class	PreReadResponseControl	The pre-read response control as defined in RFC 4527.
final class	ProxiedAuthV1RequestControl	The proxy authorization v1 request control as defined in draft-weltman-ldapv3-proxy-04.
final class	ProxiedAuthV2RequestControl	The proxy authorization v2 request control as defined in RFC 4370.
final class	RelaxRulesRequestControl	The internet-draft defined Relax Rules control.
final class	ServerSideSortRequestControl	The server-side sort request control as defined in RFC 2891.
final class	ServerSideSortResponseControl	The server-side sort response control as defined in RFC 2891.
final class	SimplePagedResultsControl	The simple paged results request and response control as defined in RFC 2696.
final class	SubentriesRequestControl	The sub-entries request control as defined in RFC 3672.
final class	SubtreeDeleteRequestControl	The tree delete request control as defined in draft-armijo-ldap-treedelete.
final class	VirtualListViewRequestControl	The virtual list view request control as defined in draft-ietf-ldapext-ldapv3-vlv.
final class	VirtualListViewResponseControl	The virtual list view response control as defined in draft-ietf-ldapext-ldapv3-vlv.

Methods in org.forgerock.opendj.ldap.controls with type parameters of type Control

Modifier and Type	Method	Description
static <C extends Control> ControlDecoder<C>	Controls.newRequestControlDecoderWithoutValue(Class<C> controlClass, String oid, String alias, Function<Control,C> decoder)	Creates a new control decoder for request controls which does not expect to find a value for the decoded control.
static <C extends Control> ControlDecoder<C>	Controls.newRequestControlDecoderWithValue(Class<C> controlClass, String oid, String alias, BiFunction<Control,DecodeOptions,C,IOException> decoder)	Creates a new control decoder for request controls which expects to find a value for the decoded control.
static <C extends Control> ControlDecoder<C>	Controls.newResponseControlDecoderWithValue(Class<C> controlClass, String oid, String alias, BiFunction<Control,DecodeOptions,C,IOException> decoder)	Creates a new control decoder for response controls which expects to find a value for the decoded control.

Methods in org.forgerock.opendj.ldap.controls with parameters of type Control

Modifier and Type	Method	Description
default C	ControlDecoder.decodeControl(Control control)	Decodes the provided control as a Control of type C using the default decode options.
C	ControlDecoder.decodeControl(Control control, DecodeOptions options)	Decodes the provided control as a Control of type C.
static GenericControl	GenericControl.newControl(Control control)	Creates a new control having the same OID, criticality, and value as the provided control.

Method parameters in org.forgerock.opendj.ldap.controls with type arguments of type Control

Modifier and Type	Method	Description
static <C extends Control> ControlDecoder<C>	Controls.newRequestControlDecoderWithoutValue(Class<C> controlClass, String oid, String alias, Function<Control,C> decoder)	Creates a new control decoder for request controls which does not expect to find a value for the decoded control.
static <C extends Control> ControlDecoder<C>	Controls.newRequestControlDecoderWithValue(Class<C> controlClass, String oid, String alias, BiFunction<Control,DecodeOptions,C,IOException> decoder)	Creates a new control decoder for request controls which expects to find a value for the decoded control.
static <C extends Control> ControlDecoder<C>	Controls.newResponseControlDecoderWithValue(Class<C> controlClass, String oid, String alias, BiFunction<Control,DecodeOptions,C,IOException> decoder)	Creates a new control decoder for response controls which expects to find a value for the decoded control.

Uses of Control in org.forgerock.opendj.ldap.messages

Methods in org.forgerock.opendj.ldap.messages with type parameters of type Control

Modifier and Type	Method	Description
<C extends Control> C	InvalidRequest.getControl(ControlDecoder<C> decoder, DecodeOptions options)
default <C extends Control> C	ProtocolOp.getControl(ControlDecoder<C> decoder)	Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder using default decode options.
default <C extends Control> C	ProtocolOp.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.

Methods in org.forgerock.opendj.ldap.messages that return types with arguments of type Control

Modifier and Type	Method	Description
List<Control>	AbandonRequest.controls()	Returns the value of the controls record component.
List<Control>	AddRequest.controls()	Returns the value of the controls record component.
List<Control>	BindRequest.controls()	Returns the value of the controls record component.
List<Control>	BindResult.controls()	Returns the value of the controls record component.
List<Control>	CancelExtendedRequest.controls()	Returns the value of the controls record component.
List<Control>	CompareRequest.controls()	Returns the value of the controls record component.
List<Control>	CompareResult.controls()	Returns the value of the controls record component.
List<Control>	DeleteRequest.controls()	Returns the value of the controls record component.
List<Control>	GenericExtendedRequest.controls()	Returns the value of the controls record component.
List<Control>	GenericExtendedResult.controls()	Returns the value of the controls record component.
List<Control>	IntermediateResponse.controls()	Returns the value of the controls record component.
List<Control>	InvalidRequest.controls()
List<Control>	ModifyDnRequest.controls()	Returns the value of the controls record component.
List<Control>	ModifyRequest.controls()	Returns the value of the controls record component.
List<Control>	PasswordModifyExtendedRequest.controls()	Returns the value of the controls record component.
List<Control>	PasswordModifyExtendedResult.controls()	Returns the value of the controls record component.
List<Control>	ProtocolOp.controls()	Returns a List containing the controls included with this protocol-op.
List<Control>	SearchRequest.controls()	Returns the value of the controls record component.
List<Control>	SearchResultEntry.controls()	Returns the value of the controls record component.
List<Control>	SearchResultReference.controls()	Returns the value of the controls record component.
List<Control>	StartTlsExtendedRequest.controls()	Returns the value of the controls record component.
List<Control>	StartTlsExtendedResult.controls()	Returns the value of the controls record component.
List<Control>	UnbindRequest.controls()	Returns the value of the controls record component.
List<Control>	UnknownRequest.controls()	Returns the value of the controls record component.
List<Control>	WhoAmIExtendedRequest.controls()	Returns the value of the controls record component.
List<Control>	WhoAmIExtendedResult.controls()	Returns the value of the controls record component.

Methods in org.forgerock.opendj.ldap.messages with parameters of type Control

Modifier and Type	Method	Description
InvalidRequest	InvalidRequest.addControl(Control control)
default ProtocolOp	ProtocolOp.addControl(Control control)	Adds the provided control to this protocol-op.

Method parameters in org.forgerock.opendj.ldap.messages with type arguments of type Control

Modifier and Type	Method	Description
InvalidRequest	InvalidRequest.addControls(Iterable<? extends Control> controls)
default ProtocolOp	ProtocolOp.addControls(Iterable<? extends Control> controls)	Adds the provided controls to this protocol-op.
static StartTlsExtendedResult	Responses.newStartTlsExtendedResult(ResultCode resultCode, String matchedDn, CharSequence diagnosticMessage, List<Control> controls, Throwable cause, SslOptions sslOptions)	Creates a new start TLS extended result which will use the provided SSL context.

Constructor parameters in org.forgerock.opendj.ldap.messages with type arguments of type Control

Modifier	Constructor	Description
	AbandonRequest(int requestId, List<Control> controls)	Create new AbandonRequest.
	AddRequest(Entry entry, List<Control> controls)	Create new AddRequest with the entry to be added and the List containing the controls.
	BindRequest(int version, Dn name, byte authenticationType, ByteString authenticationValue, String saslMechanism, ByteString saslCredentials, SaslClient saslClient, List<Control> controls)	Creates a new BindRequest.
	CancelExtendedRequest(int requestId, List<Control> controls)	Creates a new CancelExtendedRequest.
	CompareRequest(Dn name, AttributeDescription attributeDescription, ByteString assertionValue, List<Control> controls)	Create a new CompareRequest.
	DeleteRequest(Dn name, List<Control> controls)	Creates a new DeleteRequest.
	GenericExtendedRequest(String requestName, ByteString requestValue, List<Control> controls)	Creates a new GenericExtendedRequest.
	IntermediateResponse(String oid, ByteString value, List<Control> controls)	Creates a new IntermediateResponse.
	ModifyDnRequest(Dn name, Rdn newRdn, Dn newSuperior, boolean deleteOldRdn, List<Control> controls)	Create a new ModifyDnRequest.
	PasswordModifyExtendedRequest(ByteString userIdentity, ByteString oldPassword, ByteString newPassword, List<Control> controls)	Create a new PasswordModifyExtendedRequest.
	SearchResultEntry(Entry entry, List<Control> controls)	Creates a new SearchResultEntry.
	StartTlsExtendedRequest(SslOptions sslOptions, List<Control> controls)	Creates a new StartTlsExtendedRequest.
	UnbindRequest(List<Control> controls)	Create a new UnbindRequest.
	UnknownRequest(byte protocolOpType, ByteString rawProtocolOp, List<Control> controls)	Creates a new UnknownRequest.
	WhoAmIExtendedRequest(List<Control> controls)	Creates a new WhoAmIExtendedRequest.