public class LdapPersistSearchControl
extends netscape.ldap.controls.LDAPPersistSearchControl
implements javax.naming.ldap.Control
To use persistent searching for change notification, you create a "persistent search" control that specifies the types of changes that you want to track. You include the control in a search request. If an entry in the directory is changed, the server determines if the entry matches the search criteria in your request and if the change is the type of change that you are tracking. If both of these are true, the server sends the entry to your client.
The server can also include an "entry change notification" control with the entry. (The OID for this control is 2.16.840.1.113730.3.4.7.) This control contains additional information about the change made to the entry, including the type of change made, the change number (which corresponds to an item in the server's change log, if the server supports a change log), and, if the entry was renamed, the old DN of the entry.
When constructing an LDAPPersistSearchControl
object,
you can specify the following information:
LdapEntryChangeControl
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
ADD
Change type specifying that you want to track additions of new
entries to the directory.
|
static int |
DELETE
Change type specifying that you want to track removals of
entries from the directory.
|
static int |
MODDN
Change type specifying that you want to track modifications of the
DNs of entries in the directory.
|
static int |
MODIFY
Change type specifying that you want to track modifications of
entries in the directory.
|
Constructor and Description |
---|
LdapPersistSearchControl(int changeTypes,
boolean changesOnly,
boolean returnControls,
boolean isCritical)
Constructs an
LdapPersistSearchControl object
that specifies a persistent search. |
Modifier and Type | Method and Description |
---|---|
boolean |
getChangesOnly()
Indicates whether you want the server to send any existing
entries that already match the search criteria or only the
entries that have changed.
|
int |
getChangeTypes()
Gets the change types monitored by this control.
|
byte[] |
getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control.
|
boolean |
getReturnControls()
Indicates whether or not the server includes an "entry change
notification" control with each entry it sends back to the client
during the persistent search.
|
void |
setChangesOnly(boolean changesOnly)
Specifies whether you want the server to send any existing
entries that already match the search criteria or only the
entries that have changed.
|
void |
setChangeTypes(int types)
Sets the change types that you want monitored by this control.
|
void |
setReturnControls(boolean returnControls)
Specifies whether you want the server to include an "entry change
notification" control with each entry it sends back to the client
during the persistent search.
|
parseResponse, parseResponse, toString
clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register
public static final int ADD
LdapPersistSearchControl
or
by using the setChangeTypes
method.getChangeTypes()
,
setChangeTypes(int)
,
Constant Field Valuespublic static final int DELETE
LdapPersistSearchControl
or
by using the setChangeTypes
method.getChangeTypes()
,
setChangeTypes(int)
,
Constant Field Valuespublic static final int MODIFY
LdapPersistSearchControl
or
by using the setChangeTypes
method.getChangeTypes()
,
setChangeTypes(int)
,
Constant Field Valuespublic static final int MODDN
LdapPersistSearchControl
or
by using the setChangeTypes
method.getChangeTypes()
,
setChangeTypes(int)
,
Constant Field Valuespublic LdapPersistSearchControl(int changeTypes, boolean changesOnly, boolean returnControls, boolean isCritical)
LdapPersistSearchControl
object
that specifies a persistent search.changeTypes
- The change types to be monitored. You can perform
a bitwise OR on any of the following values and specify the result as
the change types:
LdapPersistSearchControl.ADD
(to track new entries
added to the directory)
LdapPersistSearchControl.DELETE
(to track entries
removed from the directory)
LdapPersistSearchControl.MODIFY
(to track entries
that have been modified)
LdapPersistSearchControl.MODDN
(to track entries
that have been renamed)
changesOnly
- true
if you do not want the server
to return all existing entries in the directory that match the
search criteria. (You just want the changed entries to be returned.)returnControls
- true
you want the server to return
entry change controls with each entry in the search results.isCritical
- true
if this control is critical to
the search operation (for example, if the server does not support
this control, you may not want the server to perform the search
at all.)LdapEntryChangeControl
public int getChangeTypes()
getChangeTypes
in class netscape.ldap.controls.LDAPPersistSearchControl
ADD, DELETE, MODIFY,
and/or MODDN
. If the change type is unknown,
this method returns -1.public boolean getChangesOnly()
getChangesOnly
in class netscape.ldap.controls.LDAPPersistSearchControl
true
, the server returns only the
entries that have changed. If false
, the server
also returns any existing entries that match the search criteria
but have not changed.public boolean getReturnControls()
getReturnControls
in class netscape.ldap.controls.LDAPPersistSearchControl
true
if the server includes "entry change
notification" controls with the entries it sends during the
persistent search.LdapEntryChangeControl
public void setChangeTypes(int types)
setChangeTypes
in class netscape.ldap.controls.LDAPPersistSearchControl
types
- Integer representing the change types that you want monitored.
This value can be the bitwise OR of ADD, DELETE, MODIFY,
and/or MODDN
.getChangeTypes()
public void setChangesOnly(boolean changesOnly)
setChangesOnly
in class netscape.ldap.controls.LDAPPersistSearchControl
changesOnly
- If true
, the server returns only the
entries that have changed. If false
, the server
also returns any existing entries that match the search criteria
but have not changed.getChangesOnly()
public void setReturnControls(boolean returnControls)
setReturnControls
in class netscape.ldap.controls.LDAPPersistSearchControl
returnControls
- If true
, the server includes
"entry change notification" controls with the entries it sends
during the persistent search.LdapEntryChangeControl
,
setReturnControls(boolean)
public byte[] getEncodedValue()
getEncodedValue
in interface javax.naming.ldap.Control