Modifier and Type | Field and Description |
---|---|
static ControlDecoder<PersistentSearchControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
Constructor and Description |
---|
PersistentSearchControl(boolean isCritical,
Set<PersistentSearchChangeType> changeTypes,
boolean changesOnly,
boolean returnECs)
Creates a new persistent search control with the provided information.
|
PersistentSearchControl(Set<PersistentSearchChangeType> changeTypes,
boolean changesOnly,
boolean returnECs)
Creates a new persistent search control with the provided information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
getChangesOnly()
Indicates whether to only return changes that match the associated search criteria, or to also return all
existing entries that match the filter.
|
Set<PersistentSearchChangeType> |
getChangeTypes()
Retrieves the set of change types for this persistent search control.
|
boolean |
getReturnECs()
Indicates whether to include the entry change notification control in entries returned to the client as the
result of a change in the Directory Server data.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
void |
toString(StringBuilder buffer)
Appends a string representation of this control to the provided buffer.
|
protected void |
writeValue(Asn1Writer writer)
Writes this control's value to an ASN.1 writer.
|
getOid, getValueAdapter, isCritical, toString, write
public static final ControlDecoder<PersistentSearchControl> DECODER
public PersistentSearchControl(Set<PersistentSearchChangeType> changeTypes, boolean changesOnly, boolean returnECs)
changeTypes
- The set of change types for which to provide notification to the client.changesOnly
- Indicates whether to only return changes that match the associated search criteria, or to also return
all existing entries that match the filter.returnECs
- Indicates whether to include the entry change notification control in updated entries that match the
associated search criteria.public PersistentSearchControl(boolean isCritical, Set<PersistentSearchChangeType> changeTypes, boolean changesOnly, boolean returnECs)
isCritical
- Indicates whether the control should be considered critical for the operation processing.changeTypes
- The set of change types for which to provide notification to the client.changesOnly
- Indicates whether to only return changes that match the associated search criteria, or to also return
all existing entries that match the filter.returnECs
- Indicates whether to include the entry change notification control in updated entries that match the
associated search criteria.public boolean hasValue()
Control
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.public ByteString getValue()
Control
protected void writeValue(Asn1Writer writer) throws IOException
Control
writeValue
in class Control
writer
- The ASN.1 writer to use.IOException
- If a problem occurs while writing to the stream.public Set<PersistentSearchChangeType> getChangeTypes()
public boolean getChangesOnly()
true
if only changes to matching entries should be returned, or false
if
existing matches should also be included.public boolean getReturnECs()
true
if entry change notification controls should be included in applicable entries, or
false
if not.public void toString(StringBuilder buffer)
Control
Copyright 2010-2020 ForgeRock AS.