org.apache.directory.api.ldap.model.message

Interface Control

All Known Subinterfaces:

AdDirSync, AdShowDeleted, Cascade, CodecControl<E>, EntryChange, ManageDsaIT, PagedResults, PasswordPolicy, PersistentSearch, ProxiedAuthz, SortRequest, SortResponse, Subentries, SyncDoneValue, SyncInfoValue, SyncRequestValue, SyncStateValue, VirtualListViewRequest, VirtualListViewResponse

All Known Implementing Classes:

AbstractControl, AdDirSyncDecorator, AdDirSyncImpl, AdShowDeletedDecorator, AdShowDeletedImpl, BasicControlDecorator, CascadeDecorator, CascadeImpl, ControlDecorator, DsmlControl, EntryChangeDecorator, EntryChangeImpl, LdifControl, ManageDsaITDecorator, ManageDsaITImpl, OpaqueControl, PagedResultsDecorator, PagedResultsImpl, PasswordPolicyDecorator, PasswordPolicyImpl, PersistentSearchDecorator, PersistentSearchImpl, ProxiedAuthzDecorator, ProxiedAuthzImpl, SortRequestControlImpl, SortRequestDecorator, SortResponseControlImpl, SortResponseDecorator, SubentriesDecorator, SubentriesImpl, SyncDoneValueDecorator, SyncDoneValueImpl, SyncInfoValueDecorator, SyncInfoValueImpl, SyncRequestValueDecorator, SyncRequestValueImpl, SyncStateValueDecorator, SyncStateValueImpl, VirtualListViewRequestDecorator, VirtualListViewRequestImpl, VirtualListViewResponseDecorator, VirtualListViewResponseImpl

public interface Control

Protocol request and response altering control interface. Any number of controls may be associated with a protocol message. Each control may be associated with a Request, a response, or both.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOid()
boolean	isCritical() Tells if the control is critical or not.
void	setCritical(boolean isCritical) Sets the critical flag which determines whether or not this control is critical for the correct operation of a request or response message.

Method Detail

getOid

java.lang.String getOid()

Returns:

The Control's OID

isCritical

boolean isCritical()

Tells if the control is critical or not.

Returns:

true if the control is critical, false otherwise

setCritical

void setCritical(boolean isCritical)

Sets the critical flag which determines whether or not this control is critical for the correct operation of a request or response message. The default for this value should be false.

Parameters:

isCritical - true if the control is critical false otherwise.