public interface ChangeLogStore
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Destroy the logs.
|
org.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> |
find()
Gets a Cursor over all the ChangeLogEvents within the system since
revision 0.
|
org.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> |
find(long startRevision,
long endRevision)
Finds the ChangeLogEvents that occurred between a revision range inclusive.
|
org.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> |
findAfter(long revision)
Finds the ChangeLogEvents that occurred after a revision exclusive.
|
org.apache.directory.api.ldap.model.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.api.ldap.model.ldif.LdifEntry forward,
org.apache.directory.api.ldap.model.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.api.ldap.model.ldif.LdifEntry forward,
List<org.apache.directory.api.ldap.model.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
|
void init(DirectoryService service) throws Exception
service
- The associated DirectoryServiceException
- If the initialization failedvoid destroy() throws Exception
Exception
- If we can't destroy the logslong getCurrentRevision()
ChangeLogEvent log(LdapPrincipal principal, org.apache.directory.api.ldap.model.ldif.LdifEntry forward, org.apache.directory.api.ldap.model.ldif.LdifEntry reverse) throws 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 changeException
- if there are problems logging the changeChangeLogEvent log(LdapPrincipal principal, org.apache.directory.api.ldap.model.ldif.LdifEntry forward, List<org.apache.directory.api.ldap.model.ldif.LdifEntry> reverses) throws 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 changeException
- if there are problems logging the changeChangeLogEvent lookup(long revision) throws Exception
revision
- to get a ChangeLogEvent forException
- if there are failures accessing the storeIllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)org.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> find() throws Exception
Exception
- if there are failures accessing the storeorg.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> findBefore(long revision) throws Exception
revision
- the revision number to get the ChangeLogEvents beforeException
- if there are failures accessing the storeIllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)org.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> findAfter(long revision) throws org.apache.directory.api.ldap.model.exception.LdapException
revision
- the revision number to get the ChangeLogEvents afterException
- if there are failures accessing the storeIllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.Cursor<ChangeLogEvent> find(long startRevision, long endRevision) throws Exception
startRevision
- the revision number to start getting the ChangeLogEvents aboveendRevision
- the revision number to start getting the ChangeLogEvents belowException
- if there are failures accessing the storeIllegalArgumentException
- if the start and end revisions are out of range
(less than 0 and greater than the current revision), or if startRevision > endRevisionCopyright © 2017. All rights reserved.