|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Control
Controls 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'.
Method Summary | |
---|---|
ByteString |
getAPIValue() Returns the value, if any, associated with this control. |
java.lang.String |
getOID() Returns the numeric OID associated with this control. |
boolean |
hasValue() Returns true if this control has a value. |
boolean |
isCritical() Returns true if it is unacceptable to perform the operation without applying the semantics of this control. |
Method Detail |
---|
java.lang.String getOID()
ByteString getAPIValue()
null
if there is no value.boolean hasValue()
true
if 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.true
if this control has a value, or false
if there is no value.boolean isCritical()
true
if 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 of true
indicates that it is unacceptable to perform the operation without applying the semantics of the control.
true
if this control must be processed by the Directory Server, or false
if it can be ignored.
|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |