org.apache.directory.server.core.changelog

Class DefaultChangeLog

java.lang.Object

org.apache.directory.server.core.changelog.DefaultChangeLog

All Implemented Interfaces:

org.apache.directory.server.core.api.changelog.ChangeLog

public class DefaultChangeLog
extends Object
implements org.apache.directory.server.core.api.changelog.ChangeLog

The default ChangeLog service implementation. It stores operations in memory. Entries are stored into a dedicated partition, named ou=changelog, under which we have two other sub-entries : ou=tags and ou= revisions : ou=changelog | +-- ou=revisions | +-- ou=tags

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
DefaultChangeLog()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
org.apache.directory.server.core.api.changelog.ChangeLogSearchEngine	getChangeLogSearchEngine()
org.apache.directory.server.core.api.changelog.ChangeLogStore	getChangeLogStore()
long	getCurrentRevision()
org.apache.directory.server.core.api.changelog.Tag	getLatest()
org.apache.directory.server.core.api.changelog.TagSearchEngine	getTagSearchEngine()
void	init(org.apache.directory.server.core.api.DirectoryService service) Initialize the ChangeLog system.
boolean	isEnabled()
boolean	isExposed()
boolean	isLogSearchSupported()
boolean	isTagSearchSupported()
boolean	isTagStorageSupported()
org.apache.directory.server.core.api.changelog.ChangeLogEvent	log(org.apache.directory.server.core.api.LdapPrincipal principal, org.apache.directory.api.ldap.model.ldif.LdifEntry forward, org.apache.directory.api.ldap.model.ldif.LdifEntry reverse)
org.apache.directory.server.core.api.changelog.ChangeLogEvent	log(org.apache.directory.server.core.api.LdapPrincipal principal, org.apache.directory.api.ldap.model.ldif.LdifEntry forward, List<org.apache.directory.api.ldap.model.ldif.LdifEntry> reverses)
void	setChangeLogStore(org.apache.directory.server.core.api.changelog.ChangeLogStore store) If there is an existing changeLog store, we don't switch it
void	setEnabled(boolean enabled)
void	setExposed(boolean exposed)
void	setPartitionSuffix(String suffix)
void	setRevisionsContainerName(String revContainerName)
void	setTagsContainerName(String tagContainerName)
void	sync()
org.apache.directory.server.core.api.changelog.Tag	tag()
org.apache.directory.server.core.api.changelog.Tag	tag(long revision)
org.apache.directory.server.core.api.changelog.Tag	tag(long revision, String description)
org.apache.directory.server.core.api.changelog.Tag	tag(String description)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultChangeLog

public DefaultChangeLog()

Method Detail

getChangeLogStore

public org.apache.directory.server.core.api.changelog.ChangeLogStore getChangeLogStore()

Specified by:

getChangeLogStore in interface org.apache.directory.server.core.api.changelog.ChangeLog

setChangeLogStore

public void setChangeLogStore(org.apache.directory.server.core.api.changelog.ChangeLogStore store)

If there is an existing changeLog store, we don't switch it

Specified by:

setChangeLogStore in interface org.apache.directory.server.core.api.changelog.ChangeLog

getCurrentRevision

public long getCurrentRevision()
                        throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

getCurrentRevision in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

log

public org.apache.directory.server.core.api.changelog.ChangeLogEvent log(org.apache.directory.server.core.api.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

Specified by:

log in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

log

public org.apache.directory.server.core.api.changelog.ChangeLogEvent log(org.apache.directory.server.core.api.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

Specified by:

log in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

isLogSearchSupported

public boolean isLogSearchSupported()

Specified by:

isLogSearchSupported in interface org.apache.directory.server.core.api.changelog.ChangeLog

isTagSearchSupported

public boolean isTagSearchSupported()

Specified by:

isTagSearchSupported in interface org.apache.directory.server.core.api.changelog.ChangeLog

isTagStorageSupported

public boolean isTagStorageSupported()

Specified by:

isTagStorageSupported in interface org.apache.directory.server.core.api.changelog.ChangeLog

getChangeLogSearchEngine

public org.apache.directory.server.core.api.changelog.ChangeLogSearchEngine getChangeLogSearchEngine()

Specified by:

getChangeLogSearchEngine in interface org.apache.directory.server.core.api.changelog.ChangeLog

getTagSearchEngine

public org.apache.directory.server.core.api.changelog.TagSearchEngine getTagSearchEngine()

Specified by:

getTagSearchEngine in interface org.apache.directory.server.core.api.changelog.ChangeLog

tag

public org.apache.directory.server.core.api.changelog.Tag tag(long revision,
                                                     String description)
                                                       throws Exception

Specified by:

tag in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

tag

public org.apache.directory.server.core.api.changelog.Tag tag(long revision)
                                                       throws Exception

Specified by:

tag in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

tag

public org.apache.directory.server.core.api.changelog.Tag tag(String description)
                                                       throws Exception

Specified by:

tag in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

tag

public org.apache.directory.server.core.api.changelog.Tag tag()
                                                       throws Exception

Specified by:

tag in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface org.apache.directory.server.core.api.changelog.ChangeLog

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.apache.directory.server.core.api.changelog.ChangeLog

getLatest

public org.apache.directory.server.core.api.changelog.Tag getLatest()
                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

getLatest in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

init

public void init(org.apache.directory.server.core.api.DirectoryService service)
          throws Exception

Initialize the ChangeLog system. We will initialize the associated store.

Specified by:

init in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

sync

public void sync()
          throws Exception

Specified by:

sync in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.apache.directory.server.core.api.changelog.ChangeLog

Throws:

Exception

isExposed

public boolean isExposed()

Specified by:

isExposed in interface org.apache.directory.server.core.api.changelog.ChangeLog

setExposed

public void setExposed(boolean exposed)

Specified by:

setExposed in interface org.apache.directory.server.core.api.changelog.ChangeLog

setPartitionSuffix

public void setPartitionSuffix(String suffix)

Specified by:

setPartitionSuffix in interface org.apache.directory.server.core.api.changelog.ChangeLog

setRevisionsContainerName

public void setRevisionsContainerName(String revContainerName)

Specified by:

setRevisionsContainerName in interface org.apache.directory.server.core.api.changelog.ChangeLog

setTagsContainerName

public void setTagsContainerName(String tagContainerName)

Specified by:

setTagsContainerName in interface org.apache.directory.server.core.api.changelog.ChangeLog

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()