|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.Control
org.opends.server.controls.LDAPPostReadRequestControl
public class LDAPPostReadRequestControl
This class implements the post-read request control as defined in RFC 4527. This control makes it possible to retrieve an entry in the state that it held immediately after an add, modify, or modify DN operation. It may specify a specific set of attributes that should be included in that entry. The entry will be encoded in a corresponding response control.
Constructor Summary | |
---|---|
LDAPPostReadRequestControl(boolean isCritical,
java.util.LinkedHashSet<java.lang.String> rawAttributes)
Creates a new instance of this LDAP post-read request control with the provided information. |
|
LDAPPostReadRequestControl(java.lang.String oid,
boolean isCritical,
java.util.LinkedHashSet<java.lang.String> rawAttributes)
Creates a new instance of this LDAP post-read request control with the provided information. |
Method Summary | |
---|---|
boolean |
allowsAttribute(AttributeType attrType)
Indicates whether the specified attribute type should be included in the entry for the corresponding response control. |
static LDAPPostReadRequestControl |
decodeControl(Control control)
Creates a new LDAP post-read request control from the contents of the provided control. |
java.util.LinkedHashSet<java.lang.String> |
getRawAttributes()
Retrieves the raw, unprocessed set of requested attributes. |
java.util.LinkedHashSet<AttributeType> |
getRequestedAttributes()
Retrieves the set of processed attributes that have been requested for inclusion in the entry that is returned. |
boolean |
returnAllOperationalAttributes()
Indicates whether the entry returned should include all operational attributes that the requester has permission to see. |
boolean |
returnAllUserAttributes()
Indicates whether the entry returned should include all user attributes that the requester has permission to see. |
void |
setRawAttributes(java.util.LinkedHashSet<java.lang.String> rawAttributes)
Specifies the raw, unprocessed set of requested attributes. |
java.lang.String |
toString()
Retrieves a string representation of this LDAP post-read request control. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP post-read request control to the provided buffer. |
Methods inherited from class org.opends.server.types.Control |
---|
getOID, getValue, hasValue, isCritical, setCritical, setOID, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPPostReadRequestControl(boolean isCritical, java.util.LinkedHashSet<java.lang.String> rawAttributes)
isCritical
- Indicates whether support for this control should be
considered a critical part of the server processing.rawAttributes
- The set of raw attributes to return in the entry.
A null or empty set will indicates that all user
attributes should be returned.public LDAPPostReadRequestControl(java.lang.String oid, boolean isCritical, java.util.LinkedHashSet<java.lang.String> rawAttributes)
oid
- The OID to use for this control.isCritical
- Indicates whether support for this control should be
considered a critical part of the server processing.rawAttributes
- The set of raw attributes to return in the entry.
A null or empty set will indicates that all user
attributes should be returned.Method Detail |
---|
public static LDAPPostReadRequestControl decodeControl(Control control) throws LDAPException
control
- The generic control containing the information to use to
create this LDAP post-read request control.
LDAPException
- If this control cannot be decoded as a valid LDAP
post-read request control.public java.util.LinkedHashSet<java.lang.String> getRawAttributes()
setRawAttributes
with
the updated set.
public void setRawAttributes(java.util.LinkedHashSet<java.lang.String> rawAttributes)
rawAttributes
- The raw, unprocessed set of requested attributes.public java.util.LinkedHashSet<AttributeType> getRequestedAttributes()
public boolean returnAllUserAttributes()
true
if the entry returned should include all user
attributes that the requester has permission to see, or
false
if it should only include user attributes that
have been explicitly included in the requested attribute list.public boolean returnAllOperationalAttributes()
true
if the entry returned should include all
operational attributes that the requester has permission to see,
or false
if it should only include user attributes
that have been explicitly included in the requested attribute
list.public boolean allowsAttribute(AttributeType attrType)
attrType
- The attribute type for which to make the determination.
true
if the specified attribute type should be
included in the entry for the corresponding response control, or
false
if not.public java.lang.String toString()
toString
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |