|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.protocols.ldap.LDAPControl
public class LDAPControl
This class defines the data structures and methods to use when interacting with a generic LDAP control or set of controls.
Constructor Summary | |
---|---|
LDAPControl(Control control)
Creates a new LDAP control with the information in the provided control. |
|
LDAPControl(java.lang.String oid)
Creates a new LDAP control with the specified OID. |
|
LDAPControl(java.lang.String oid,
boolean isCritical)
Creates a new LDAP control with the specified OID and criticality. |
|
LDAPControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new LDAP control with the specified OID, criticality, and value. |
Method Summary | |
---|---|
static LDAPControl |
decode(ASN1Element element)
Decodes the provided ASN.1 element as an LDAP control. |
static java.util.ArrayList<LDAPControl> |
decodeControls(ASN1Element element)
Decodes the provided ASN.1 element as a set of controls. |
ASN1Element |
encode()
Encodes this control to an ASN.1 element. |
static ASN1Element |
encodeControls(java.util.ArrayList<LDAPControl> controls)
Encodes the provided set of controls into an ASN.1 sequence. |
Control |
getControl()
Retrieves the control wrapped by this LDAP control. |
java.lang.String |
getOID()
Retrieves the OID for this control. |
ASN1OctetString |
getValue()
Retrieves the value for this control. |
boolean |
isCritical()
Indicates whether this control should be considered critical. |
java.lang.String |
toString()
Retrieves a string representation of this LDAP control. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer. |
void |
toString(java.lang.StringBuilder buffer,
int indent)
Appends a multi-line string representation of this LDAP control to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPControl(Control control)
control
- The control to use to create this LDAP control.public LDAPControl(java.lang.String oid)
oid
- The OID for this LDAP control.public LDAPControl(java.lang.String oid, boolean isCritical)
oid
- The OID for this LDAP control.isCritical
- Indicates whether this control should be considered
critical.public LDAPControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
oid
- The OID for this LDAP control.isCritical
- Indicates whether this control should be considered
critical.value
- The value for this LDAP control.Method Detail |
---|
public Control getControl()
public ASN1Element encode()
public static ASN1Element encodeControls(java.util.ArrayList<LDAPControl> controls)
controls
- The set of controls to encode.
public static LDAPControl decode(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If a problem occurs while attempting to decode the
provided ASN.1 element as an LDAP control.public static java.util.ArrayList<LDAPControl> decodeControls(ASN1Element element) throws LDAPException
element
- The ASN.1 element containing the encoded set of controls.
LDAPException
- If a problem occurs while attempting to decode the
controls.public java.lang.String getOID()
public boolean isCritical()
true
if this control should be considered critical,
or false
if not.public ASN1OctetString getValue()
null
if there is none.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be appended.public void toString(java.lang.StringBuilder buffer, int indent)
buffer
- The buffer to which the information should be appended.indent
- The number of spaces to indent the information.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |