|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChangeLogStore
A store for change events on the directory which exposes methods for managing, querying and in general performing legal operations on the log.
Method Summary | |
---|---|
void |
destroy()
Destroy the logs. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find()
Gets a Cursor over all the ChangeLogEvents within the system since revision 0. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
find(long startRevision,
long endRevision)
Finds the ChangeLogEvents that occurred between a revision range inclusive. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
findAfter(long revision)
Finds the ChangeLogEvents that occurred after a revision exclusive. |
org.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> |
findBefore(long revision)
Gets a Cursor over the ChangeLogEvents that occurred before a revision exclusive. |
long |
getCurrentRevision()
Gets the current revision of the server (a.k.a. |
void |
init(DirectoryService service)
Initialize the store. |
ChangeLogEvent |
log(LdapPrincipal principal,
org.apache.directory.shared.ldap.ldif.LdifEntry forward,
org.apache.directory.shared.ldap.ldif.LdifEntry reverse)
Records a change as a forward LDIF, a reverse change to revert the change and the authorized principal triggering the revertable change event. |
ChangeLogEvent |
log(LdapPrincipal principal,
org.apache.directory.shared.ldap.ldif.LdifEntry forward,
java.util.List<org.apache.directory.shared.ldap.ldif.LdifEntry> reverses)
Records a change as a forward LDIF, some reverse changes to revert the change and the authorized principal triggering the revertable change event. |
ChangeLogEvent |
lookup(long revision)
Looks up the ChangeLogEvent for a revision. |
void |
sync()
Write the changes on disk |
Method Detail |
---|
void init(DirectoryService service) throws java.lang.Exception
service
- The associated DirectoryService
java.lang.Exception
- If the initialization failedvoid sync() throws java.lang.Exception
java.lang.Exception
- If the write failedvoid destroy() throws java.lang.Exception
java.lang.Exception
- If we can't destroy the logslong getCurrentRevision()
ChangeLogEvent log(LdapPrincipal principal, org.apache.directory.shared.ldap.ldif.LdifEntry forward, org.apache.directory.shared.ldap.ldif.LdifEntry reverse) throws java.lang.Exception
principal
- the authorized LDAP principal triggering the changeforward
- LDIF of the change going to the next statereverse
- LDIF (anti-operation): the change required to revert this change
java.lang.Exception
- if there are problems logging the changeChangeLogEvent log(LdapPrincipal principal, org.apache.directory.shared.ldap.ldif.LdifEntry forward, java.util.List<org.apache.directory.shared.ldap.ldif.LdifEntry> reverses) throws java.lang.Exception
principal
- the authorized LDAP principal triggering the changeforward
- LDIF of the change going to the next statereverses
- LDIF (anti-operation): the changes required to revert this change
java.lang.Exception
- if there are problems logging the changeChangeLogEvent 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() throws java.lang.Exception
java.lang.Exception
- if there are failures accessing the storeorg.apache.directory.shared.ldap.cursor.Cursor<ChangeLogEvent> findBefore(long revision) throws java.lang.Exception
revision
- the revision number to get the ChangeLogEvents before
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) throws java.lang.Exception
revision
- the revision number to get the ChangeLogEvents after
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) throws java.lang.Exception
startRevision
- the revision number to start getting the ChangeLogEvents aboveendRevision
- the revision number to start getting the ChangeLogEvents below
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 > endRevision
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |