public interface ChangeLog
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Destroy the changeLog
|
ChangeLogSearchEngine |
getChangeLogSearchEngine()
Gets the change log query engine which would be used to ask questions
about what changed, when, how and by whom.
|
ChangeLogStore |
getChangeLogStore() |
long |
getCurrentRevision()
Gets the current revision for the server.
|
Tag |
getLatest() |
TagSearchEngine |
getTagSearchEngine()
Gets the tag search engine used to query the snapshots taken.
|
void |
init(DirectoryService service)
Initialize the ChangeLog system.
|
boolean |
isEnabled()
Checks whether or not the change log has been enabled to track changes.
|
boolean |
isExposed() |
boolean |
isLogSearchSupported()
Returns whether or not this ChangeLogService supports searching for changes.
|
boolean |
isTagSearchSupported()
Returns whether or not this ChangeLogService supports searching for snapshot tags.
|
boolean |
isTagStorageSupported()
Returns whether or not this ChangeLogService stores snapshot tags.
|
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.
|
void |
setChangeLogStore(ChangeLogStore store)
Set the underlying storage
|
void |
setEnabled(boolean enabled)
Enable or disable the ChangeLog service
|
void |
setExposed(boolean exposed)
Exposes the contents of ChangeLog to clients if set to true.
|
void |
setPartitionSuffix(String suffix)
The prefix of the partition.
|
void |
setRevisionsContainerName(String revContainerName)
The name of the revisions container under the partition.
|
void |
setTagsContainerName(String tagContainerName)
The name of the tags container under the partition.
|
void |
sync()
Flush the changes to disk
|
Tag |
tag()
Creates a snapshot of the server at the current revision.
|
Tag |
tag(long revision)
Creates a tag for a snapshot of the server in a specific state at a revision.
|
Tag |
tag(long revision,
String description)
Creates a tag for a snapshot of the server in a specific state at a revision.
|
Tag |
tag(String description)
Creates a snapshot of the server at the current revision.
|
boolean isEnabled()
void setEnabled(boolean enabled)
enabled
- true to enable the service, flase to disable itChangeLogStore getChangeLogStore()
void setChangeLogStore(ChangeLogStore store)
store
- The storagelong getCurrentRevision() throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
- if there is a problem accessing this informationChangeLogEvent log(LdapPrincipal principal, org.apache.directory.api.ldap.model.ldif.LdifEntry forward, org.apache.directory.api.ldap.model.ldif.LdifEntry reverse) throws org.apache.directory.api.ldap.model.exception.LdapException
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 changeorg.apache.directory.api.ldap.model.exception.LdapException
- 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 org.apache.directory.api.ldap.model.exception.LdapException
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 changeorg.apache.directory.api.ldap.model.exception.LdapException
- if there are problems logging the changeboolean isLogSearchSupported()
boolean isTagSearchSupported()
boolean isTagStorageSupported()
ChangeLogSearchEngine getChangeLogSearchEngine()
UnsupportedOperationException
- if the change log is not searchableTagSearchEngine getTagSearchEngine()
UnsupportedOperationException
- if the tag searching is not supportedTag tag(long revision) throws Exception
revision
- the revision to tag the snapshotException
- if there is a problem taking a tagIllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)Tag tag(long revision, String description) throws Exception
revision
- the revision to tag the snapshotdescription
- some information about what the snapshot tag representsException
- if there is a problem taking a tagIllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)Tag tag(String description) throws Exception
description
- some information about what the snapshot tag representsException
- if there is a problem taking a tagTag tag() throws Exception
Exception
- if there is a problem taking a tagTag getLatest() throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
- if there is a problem taking the latest tagvoid init(DirectoryService service) throws org.apache.directory.api.ldap.model.exception.LdapException
service
- The associated DirectoryServiceorg.apache.directory.api.ldap.model.exception.LdapException
- If the initialization failedvoid sync() throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
- If the flush failedvoid destroy() throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
- If the destroy failedvoid setExposed(boolean exposed)
exposed
- true to expose the contents, false to not expose.boolean isExposed()
void setPartitionSuffix(String suffix)
suffix
- suffix value to be set for the changelog partitionvoid setRevisionsContainerName(String revContainerName)
revContainerName
- the name of the revisions containervoid setTagsContainerName(String tagContainerName)
tagContainerName
- the name of the revisions containerCopyright © 2003–2020 The Apache Software Foundation. All rights reserved.