|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.core.changelog.DefaultChangeLog
public class DefaultChangeLog
The default ChangeLog service implementation.
Constructor Summary | |
---|---|
DefaultChangeLog()
|
Method Summary | |
---|---|
void |
destroy()
|
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)
|
boolean |
isEnabled()
Checks whether or not the change log has been enabled to track changes. |
boolean |
isExposeChangeLog()
|
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.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. |
void |
setChangeLogStore(ChangeLogStore store)
|
void |
setEnabled(boolean enabled)
|
void |
setExposeChangeLog(boolean exposeChangeLog)
Exposes the contents of ChangeLog to clients if set to true. |
void |
setPartitionSuffix(java.lang.String suffix)
The prefix of the partition. |
void |
setRevisionsContainerName(java.lang.String revContainerName)
The name of the revisions container under the partition. |
void |
setTagsContainerName(java.lang.String tagContainerName)
The name of the tags container under the partition. |
void |
sync()
|
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,
java.lang.String description)
Creates a tag for a snapshot of the server in a specific state at a revision. |
Tag |
tag(java.lang.String description)
Creates a snapshot of the server at the current revision. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DefaultChangeLog()
Method Detail |
---|
public ChangeLogStore getChangeLogStore()
getChangeLogStore
in interface ChangeLog
public void setChangeLogStore(ChangeLogStore store)
setChangeLogStore
in interface ChangeLog
public long getCurrentRevision() throws java.lang.Exception
ChangeLog
getCurrentRevision
in interface ChangeLog
java.lang.Exception
- if there is a problem accessing this informationpublic ChangeLogEvent log(LdapPrincipal principal, org.apache.directory.shared.ldap.ldif.LdifEntry forward, org.apache.directory.shared.ldap.ldif.LdifEntry reverse) throws java.lang.Exception
log
in interface ChangeLog
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 changepublic ChangeLogEvent 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
log
in interface ChangeLog
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 changepublic boolean isLogSearchSupported()
ChangeLog
isLogSearchSupported
in interface ChangeLog
public boolean isTagSearchSupported()
ChangeLog
isTagSearchSupported
in interface ChangeLog
public boolean isTagStorageSupported()
ChangeLog
isTagStorageSupported
in interface ChangeLog
public ChangeLogSearchEngine getChangeLogSearchEngine()
ChangeLog
getChangeLogSearchEngine
in interface ChangeLog
public TagSearchEngine getTagSearchEngine()
ChangeLog
getTagSearchEngine
in interface ChangeLog
public Tag tag(long revision, java.lang.String description) throws java.lang.Exception
ChangeLog
tag
in interface ChangeLog
revision
- the revision to tag the snapshotdescription
- some information about what the snapshot tag represents
java.lang.Exception
- if there is a problem taking a tag
java.lang.IllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)public Tag tag(long revision) throws java.lang.Exception
ChangeLog
tag
in interface ChangeLog
revision
- the revision to tag the snapshot
java.lang.Exception
- if there is a problem taking a tag
java.lang.IllegalArgumentException
- if the revision is out of range (less than 0
and greater than the current revision)public Tag tag(java.lang.String description) throws java.lang.Exception
ChangeLog
tag
in interface ChangeLog
description
- some information about what the snapshot tag represents
java.lang.Exception
- if there is a problem taking a tagpublic Tag tag() throws java.lang.Exception
ChangeLog
tag
in interface ChangeLog
java.lang.Exception
- if there is a problem taking a tagpublic void setEnabled(boolean enabled)
setEnabled
in interface ChangeLog
public boolean isEnabled()
ChangeLog
isEnabled
in interface ChangeLog
public Tag getLatest() throws java.lang.Exception
getLatest
in interface ChangeLog
java.lang.Exception
public void init(DirectoryService service) throws java.lang.Exception
init
in interface ChangeLog
java.lang.Exception
public void sync() throws java.lang.Exception
sync
in interface ChangeLog
java.lang.Exception
public void destroy() throws java.lang.Exception
destroy
in interface ChangeLog
java.lang.Exception
public boolean isExposeChangeLog()
isExposeChangeLog
in interface ChangeLog
ChangeLog.isExposeChangeLog()
public void setExposeChangeLog(boolean exposeChangeLog)
ChangeLog
setExposeChangeLog
in interface ChangeLog
exposeChangeLog
- true to expose the contents, false to not expose.ChangeLog.setExposeChangeLog(boolean)
public void setPartitionSuffix(java.lang.String suffix)
ChangeLog
setPartitionSuffix
in interface ChangeLog
suffix
- suffix value to be set for the changelog partitionChangeLog.setPartitionSuffix(String)
public void setRevisionsContainerName(java.lang.String revContainerName)
ChangeLog
setRevisionsContainerName
in interface ChangeLog
revContainerName
- the name of the revisions containerChangeLog.setRevisionsContainerName(String)
public void setTagsContainerName(java.lang.String tagContainerName)
ChangeLog
setTagsContainerName
in interface ChangeLog
tagContainerName
- the name of the revisions containerChangeLog.setTagsContainerName(String)
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |