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.
org.forgerock.opendj.rest2ldap	APIs for implementing REST to LDAP gateways.
org.forgerock.opendj.server.leaderbasedreplication	This package contains the main class of the leader based replication.
org.opends.server.api	Contains a number of API declarations for use throughout the Directory Server.
org.opends.server.authorization.dseecompat	Contains the Directory Server Sun Java System Directory Server Enterprise Edition (dseecompat) compatability access control handler implementation.
org.opends.server.authorization.policy	Contains the policy based access control handler implementation.
org.opends.server.controls	Contains classes that represent specific LDAP controls and their values.
org.opends.server.core	Contains various classes that comprise the core of the Directory Server codebase.
org.opends.server.plugins	Contains the implementation for various Directory Server plugins.
org.opends.server.replication.plugin	This package contains the part of the Multi-master replication code that works on the Directory Server side.
org.opends.server.types	Contains implementations for a number of Directory Server data types.
org.opends.server.types.operation	Contains a number of interfaces that are implemented by the various types of Directory Server operations.

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.

Uses of Control in org.forgerock.opendj.rest2ldap

Constructors in org.forgerock.opendj.rest2ldap with parameters of type Control

Modifier	Constructor	Description
	LdapClientContext(org.forgerock.services.context.Context parent, LdapClient ldapClientForReadingSchema, LdapClientSocket ldapClientSocketForUserRequests, Control optionalProxiedAuthControl)	Creates a new LDAP client context having the provided parent and an ID automatically generated using UUID.randomUUID().

Uses of Control in org.forgerock.opendj.server.leaderbasedreplication

Classes in org.forgerock.opendj.server.leaderbasedreplication that implement Control

Modifier and Type	Class	Description
final class	FetchChangelogUpdatesControl	This class implements the request control used to fetch updates from another server, in order to replicate those updates.

Uses of Control in org.opends.server.api

Methods in org.opends.server.api with parameters of type Control

Modifier and Type	Method	Description
boolean	AccessControlHandler.isAllowed(Dn dn, Operation op, Control control)	Indicates whether the provided control is allowed based on the access control configuration and the specified operation.

Uses of Control in org.opends.server.authorization.dseecompat

Methods in org.opends.server.authorization.dseecompat with parameters of type Control

Modifier and Type	Method	Description
boolean	AciHandler.isAllowed(Dn entryDN, Operation op, Control control)

Uses of Control in org.opends.server.authorization.policy

Methods in org.opends.server.authorization.policy with parameters of type Control

Modifier and Type	Method	Description
boolean	PolicyBasedAccessControlHandler.isAllowed(Dn dn, Operation op, Control control)

Uses of Control in org.opends.server.controls

Classes in org.opends.server.controls that implement Control

Modifier and Type	Class	Description
final class	EntryChangelogNotificationResponseControl	This class implements the ECL cookie control.
final class	ExternalChangelogRequestControl	This class implements the request control used to browse the external changelog.
final class	InternalModificationsRequestControl	A control providing additional modifications to a request.
final class	ReplicatedRequestControl	Control that provides some replication context to requests.
final class	SearchBaseDnBackendOnlyControl	Tell the operation router to not run a search into subordinate backends.

Uses of Control in org.opends.server.core

Methods in org.opends.server.core that return types with arguments of type Control

Modifier and Type	Method	Description
List<Control>	AbandonOperation.getResponseControls()
List<Control>	UnbindOperation.getResponseControls()

Methods in org.opends.server.core with parameters of type Control

Modifier and Type	Method	Description
void	AbandonOperation.addResponseControl(Control control)
void	UnbindOperation.addResponseControl(Control control)
void	AbandonOperation.removeResponseControl(Control control)
void	UnbindOperation.removeResponseControl(Control control)

Method parameters in org.opends.server.core with type arguments of type Control

Modifier and Type	Method	Description
void	SearchOperation.returnEntry(Entry entry, List<Control> controls)	Used as a callback for backends to indicate that the provided entry matches the search criteria and that additional processing should be performed to potentially send it back to the client.

Uses of Control in org.opends.server.plugins

Classes in org.opends.server.plugins that implement Control

Modifier and Type	Class	Description
static final class	ChangeNumberControlPlugin.CsnResponseControl	The control used by this plugin.

Uses of Control in org.opends.server.replication.plugin

Classes in org.opends.server.replication.plugin that implement Control

Modifier and Type	Class	Description
final class	ReplicationRepairRequestControl	This class implements the Sun-defined replication repair control.

Uses of Control in org.opends.server.types

Methods in org.opends.server.types with type parameters of type Control

Modifier and Type	Method	Description
final <T extends Control> T	Operation.getRequestControl(ControlDecoder<T> d, DecodeOptions options)

Methods in org.opends.server.types that return types with arguments of type Control

Modifier and Type	Method	Description
final List<Control>	Operation.getRequestControls()
List<Control>	Operation.getResponseControls()

Methods in org.opends.server.types with parameters of type Control

Modifier and Type	Method	Description
final void	Operation.addRequestControl(Control control)	Adds the provided control to the set of request controls for this operation.
void	Operation.addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
void	Operation.removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.

Uses of Control in org.opends.server.types.operation

Methods in org.opends.server.types.operation with type parameters of type Control

Modifier and Type	Method	Description
default <T extends Control> T	PluginOperation.getRequestControl(ControlDecoder<T> d)	Retrieves a control included in the request from the client using the default decode options.
<T extends Control> T	PluginOperation.getRequestControl(ControlDecoder<T> d, DecodeOptions options)	Retrieves a control included in the request from the client.

Methods in org.opends.server.types.operation that return types with arguments of type Control

Modifier and Type	Method	Description
List<Control>	PluginOperation.getRequestControls()	Retrieves the set of controls included in the request from the client.
List<Control>	PluginOperation.getResponseControls()	Retrieves the set of controls to include in the response to the client.

Methods in org.opends.server.types.operation with parameters of type Control

Modifier and Type	Method	Description
void	PreParseOperation.addRequestControl(Control control)	Adds the provided control to the set of request controls for this operation.
void	InProgressOperation.addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
void	PostOperationOperation.addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
void	PreOperationOperation.addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
void	PreParseOperation.addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
void	InProgressOperation.removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
void	PostOperationOperation.removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
void	PreOperationOperation.removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
void	PreParseOperation.removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.

Method parameters in org.opends.server.types.operation with type arguments of type Control

Modifier and Type	Method	Description
void	PreOperationSearchOperation.returnEntry(Entry entry, List<Control> controls)	Returns the provided entry to the client.
void	PreParseSearchOperation.returnEntry(Entry entry, List<Control> controls)	Returns the provided entry to the client.