|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChangeLogSearchEngine
A custom search engine designed for optimized searching across ChangeLogEvents within the ChangeLogStore. The following lookup and search operations are provided:
Method Summary | |
---|---|
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(org.apache.directory.shared.ldap.schema.AttributeType attributeType,
RevisionOrder order)
Finds all the ChangeLogEvents altering a particular attributeType. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(org.apache.directory.shared.ldap.ldif.ChangeType changeType,
RevisionOrder order)
Finds all the ChangeLogEvents of a particular change type. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(org.apache.directory.shared.ldap.name.DN dn,
RevisionOrder order)
Finds all the ChangeLogEvents on an entry. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(org.apache.directory.shared.ldap.name.DN base,
Scope scope,
RevisionOrder order)
Finds all the ChangeLogEvents on an entry base and/or it's children/descendants. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(org.apache.directory.shared.ldap.filter.ExprNode filter,
RevisionOrder order)
Finds all the ChangeLogEvents matched by the filter expression tree parameter. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(LdapPrincipal principal,
RevisionOrder order)
Finds all the ChangeLogEvents triggered by a principal in the system. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(long startRevision,
long endRevision,
RevisionOrder order)
Finds the ChangeLogEvents that occurred between a revision range inclusive. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(org.apache.directory.shared.ldap.schema.ObjectClass objectClass,
RevisionOrder order)
Finds all the ChangeLogEvents altering a particular objectClass. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(RevisionOrder order)
Finds all the ChangeLogEvents within the system since revision 0. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
findAfter(long revision,
RevisionOrder order)
Finds the ChangeLogEvents that occurred after a revision inclusive. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
findBefore(long revision,
RevisionOrder order)
Finds the ChangeLogEvents that occurred before a revision inclusive. |
ChangeLogEvent |
lookup(long revision)
Looks up the ChangeLogEvent for a revision. |
long |
lookup(java.lang.String generalizedTime)
Looks up the revision in effect at some time specified by a generalized time descriptor. |
Method Detail |
---|
long lookup(java.lang.String generalizedTime) throws java.lang.Exception
generalizedTime
- the generalized time descriptor to find the effective revision for
java.lang.Exception
- if there are failures accessing the storeChangeLogEvent lookup(long revision) throws java.lang.Exception
revision
- to get a ChangeLogEvent for
java.lang.Exception
- if there are failures accessing the store
java.lang.IllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(RevisionOrder order) throws java.lang.Exception
order
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> findBefore(long revision, RevisionOrder order) throws java.lang.Exception
revision
- the revision number to get the ChangeLogEvents beforeorder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the store
java.lang.IllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> findAfter(long revision, RevisionOrder order) throws java.lang.Exception
revision
- the revision number to get the ChangeLogEvents afterorder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the store
java.lang.IllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(long startRevision, long endRevision, RevisionOrder order) throws java.lang.Exception
startRevision
- the revision number to start getting the ChangeLogEvents aboveendRevision
- the revision number to start getting the ChangeLogEvents beloworder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the store
java.lang.IllegalArgumentException
- if the start and end revisions are out of range
(less than 0 and greater than the current revision), or if startRevision > endRevisionorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(org.apache.directory.shared.ldap.name.DN dn, RevisionOrder order) throws java.lang.Exception
dn
- the normalized DN of the entry to get ChangeLogEvents fororder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(org.apache.directory.shared.ldap.name.DN base, Scope scope, RevisionOrder order) throws java.lang.Exception
base
- the normalized DN of the entry base to get ChangeLogEvents forscope
- the scope of the search under the base similar to LDAP search scopeorder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(LdapPrincipal principal, RevisionOrder order) throws java.lang.Exception
principal
- the LDAP principal who triggered the eventsorder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(org.apache.directory.shared.ldap.ldif.ChangeType changeType, RevisionOrder order) throws java.lang.Exception
changeType
- the change type of the ChangeLogEvents to search fororder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(org.apache.directory.shared.ldap.schema.AttributeType attributeType, RevisionOrder order) throws java.lang.Exception
attributeType
- the attributeType definition for the changed attribute to search changes fororder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(org.apache.directory.shared.ldap.schema.ObjectClass objectClass, RevisionOrder order) throws java.lang.Exception
objectClass
- the objectClass definition for the entries to search changes fororder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> find(org.apache.directory.shared.ldap.filter.ExprNode filter, RevisionOrder order) throws java.lang.Exception
filter
- the filter to use for finding the changeorder
- the order in which to return ChangeLogEvents (ordered by revision number)
java.lang.Exception
- if there are failures accessing the store
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |