Interface Control
-
- All Known Implementing Classes:
AdNotificationRequestControl,AssertionRequestControl,AuthorizationIdentityRequestControl,AuthorizationIdentityResponseControl,ChangeNumberControlPlugin.ChangeNumberResponseControl,EntryChangelogNotificationResponseControl,EntryChangeNotificationResponseControl,ExternalChangelogRequestControl,GenericControl,GetEffectiveRightsRequestControl,InternalModificationsRequestControl,ManageDsaItRequestControl,MatchedValuesRequestControl,PasswordExpiredResponseControl,PasswordExpiringResponseControl,PasswordPolicyRequestControl,PasswordPolicyResponseControl,PermissiveModifyRequestControl,PersistentSearchRequestControl,PostReadRequestControl,PostReadResponseControl,PreReadRequestControl,PreReadResponseControl,ProxiedAuthV1RequestControl,ProxiedAuthV2RequestControl,RelaxRulesRequestControl,ReplicatedRequestControl,ReplicationRepairRequestControl,SearchBaseDnBackendOnlyControl,ServerSideSortRequestControl,ServerSideSortResponseControl,SimplePagedResultsControl,SubentriesRequestControl,SubtreeDeleteRequestControl,VirtualListViewRequestControl,VirtualListViewResponseControl
public interface ControlControls provide a mechanism whereby the semantics and arguments of existing LDAP operations may be extended. One or more controls may be attached to a single LDAP message. A control only affects the semantics of the message it is attached to. Controls sent by clients are termed 'request controls', and those sent by servers are termed 'response controls'.To determine whether a directory server supports a given control, read the list of supported controls from the root DSE to get a collection of control OIDs, and then check for a match:
Connection connection = ...; Collection<String> supported = RootDSE.readRootDSE(connection).getSupportedControls(); Control control = ...; String OID = control.getOID(); if (supported != null && !supported.isEmpty() && supported.contains(OID)) { // The control is supported. Use it here... }
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetOid()Returns the numeric OID associated with this control.ByteStringgetValue()Returns the value, if any, associated with this control.booleanhasValue()Returnstrueif this control has a value.booleanisCritical()Returnstrueif it is unacceptable to perform the operation without applying the semantics of this control.
-
-
-
Method Detail
-
getOid
String getOid()
Returns the numeric OID associated with this control.- Returns:
- The numeric OID associated with this control.
-
getValue
ByteString getValue()
Returns the value, if any, associated with this control. Its format is defined by the specification of this control.- Returns:
- The value associated with this control, or
nullif there is no value.
-
hasValue
boolean hasValue()
Returnstrueif this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.- Returns:
trueif this control has a value, orfalseif there is no value.
-
isCritical
boolean isCritical()
Returnstrueif it is unacceptable to perform the operation without applying the semantics of this control.The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be
false, and MUST be ignored by the receiving protocol peer. A value oftrueindicates that it is unacceptable to perform the operation without applying the semantics of the control.- Returns:
trueif this control must be processed by the Directory Server, orfalseif it can be ignored.
-
-