org.apache.directory.server.ldap.replication.provider

Class ReplicaEventLog

java.lang.Object

org.apache.directory.server.ldap.replication.provider.ReplicaEventLog

All Implemented Interfaces:

java.lang.Comparable<ReplicaEventLog>

public class ReplicaEventLog
extends java.lang.Object
implements java.lang.Comparable<ReplicaEventLog>

A structure storing the configuration on each consumer registered on a producer. It stores the following informations :

• replicaId : the internal ID associated with the consumer on the provider
• hostname : the consumer's host
• searchFilter : the filter
• lastSentCsn : the last CSN sent by the consumer
• refreshNPersist : a flag indicating that the consumer is processing in Refresh and persist mode

A separate log is maintained for each syncrepl consumer.
We also associate a Queue with each structure, which will store the messages to send to the consumer.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.name.Dn	consumerEntryDn the DN of the entry where this event log details are stored
static int	DEFAULT_MAX_IDLE_PERIOD The max delay for an idle replication log with no activity, by default the logs have no idle time period
static int	DEFAULT_PURGE_THRESHOLD_COUNT
private boolean	dirty A flag used to indicate that the consumer is not up to date
private java.lang.String	hostName hostname of the syncrepl consumer
private JdbmTable<java.lang.String,ReplicaEventMessage>	journal The Journal of modifications
private java.io.File	journalFile the underlying file
private java.lang.String	lastSentCsn the csn that was sent to the client during the last sync session
private static org.slf4j.Logger	LOG The logger
private long	maxIdlePeriod the duration(in seconds) of consumer inactivity after which this log will be deleted.
private SyncReplSearchListener	persistentListener the persistent listener
private static org.slf4j.Logger	PROVIDER_LOG A logger for the replication provider
private int	purgeThresholdCount the minimum number of entries to be present for beginning purging entries older than the last sent CSN.
private jdbm.RecordManager	recman The record manager
private boolean	refreshNPersist flag indicating refreshAndPersist mode
static java.lang.String	REPLICA_EVENT_LOG_NAME_PREFIX
private int	replicaId the replica id
private NotificationCriteria	searchCriteria notification criteria used by the persistent search
private java.lang.String	searchFilter the unmodified search filter as it was when received from the client

Constructor Summary

Constructors

Constructor and Description
ReplicaEventLog(DirectoryService directoryService, int replicaId) Creates a new instance of EventLog for a replica

Method Summary

Modifier and Type	Method and Description
int	compareTo(ReplicaEventLog o)
long	count()
boolean	equals(java.lang.Object obj)
org.apache.directory.api.ldap.model.name.Dn	getConsumerEntryDn()
ReplicaJournalCursor	getCursor(java.lang.String consumerCsn)
java.lang.String	getHostName()
int	getId()
java.lang.String	getLastSentCsn()
long	getMaxIdlePeriod()
java.lang.String	getName()
SyncReplSearchListener	getPersistentListener()
int	getPurgeThresholdCount()
java.lang.String	getQueueName()
NotificationCriteria	getSearchCriteria()
java.lang.String	getSearchFilter()
int	hashCode()
boolean	isDirty()
boolean	isRefreshNPersist()
void	log(ReplicaEventMessage message) Stores the given message in the queue
void	recreate() Re-create the queue
void	setConsumerEntryDn(org.apache.directory.api.ldap.model.name.Dn consumerEntryDn)
void	setDirty(boolean dirty) Set the dirty flag
void	setHostName(java.lang.String hostName) Set the consumer hostname
void	setLastSentCsn(java.lang.String lastSentCsn) Update the last Sent CSN.
void	setMaxIdlePeriod(long maxIdlePeriod)
void	setPersistentListener(SyncReplSearchListener persistentListener) Set the listener
void	setPurgeThresholdCount(int purgeThresholdCount)
void	setRefreshNPersist(boolean refreshNPersist)
void	setSearchCriteria(NotificationCriteria searchCriteria) Stores the search criteria
void	setSearchFilter(java.lang.String searchFilter) Set the searchFilter
void	stop() Stop the EventLog
java.lang.String	toString()
void	truncate() Deletes the queue (to remove the log) and recreates a new queue instance with the same queue name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger

PROVIDER_LOG

private static final org.slf4j.Logger PROVIDER_LOG

A logger for the replication provider

hostName

private java.lang.String hostName

hostname of the syncrepl consumer

searchFilter

private java.lang.String searchFilter

the unmodified search filter as it was when received from the client

lastSentCsn

private java.lang.String lastSentCsn

the csn that was sent to the client during the last sync session

persistentListener

private SyncReplSearchListener persistentListener

the persistent listener

searchCriteria

private NotificationCriteria searchCriteria

notification criteria used by the persistent search

replicaId

private int replicaId

the replica id

refreshNPersist

private boolean refreshNPersist

flag indicating refreshAndPersist mode

maxIdlePeriod

private long maxIdlePeriod

the duration(in seconds) of consumer inactivity after which this log will be deleted. Defaults to 172800 seconds (i.e. 2 days)

purgeThresholdCount

private int purgeThresholdCount

the minimum number of entries to be present for beginning purging entries older than the last sent CSN. Default is 10000

journal

private JdbmTable<java.lang.String,ReplicaEventMessage> journal

The Journal of modifications

journalFile

private java.io.File journalFile

the underlying file

recman

private jdbm.RecordManager recman

The record manager

dirty

private volatile boolean dirty

A flag used to indicate that the consumer is not up to date

consumerEntryDn

private org.apache.directory.api.ldap.model.name.Dn consumerEntryDn

the DN of the entry where this event log details are stored

REPLICA_EVENT_LOG_NAME_PREFIX

public static final java.lang.String REPLICA_EVENT_LOG_NAME_PREFIX

See Also:

Constant Field Values

DEFAULT_PURGE_THRESHOLD_COUNT

public static final int DEFAULT_PURGE_THRESHOLD_COUNT

See Also:

Constant Field Values

DEFAULT_MAX_IDLE_PERIOD

public static final int DEFAULT_MAX_IDLE_PERIOD

The max delay for an idle replication log with no activity, by default the logs have no idle time period

See Also:

Constant Field Values

Constructor Detail

ReplicaEventLog

public ReplicaEventLog(DirectoryService directoryService,
                       int replicaId)
                throws java.io.IOException

Creates a new instance of EventLog for a replica

Parameters:

directoryService - The DirectoryService instance

replicaId - The replica ID

Throws:

java.io.IOException

Method Detail

log

public void log(ReplicaEventMessage message)

Stores the given message in the queue

Parameters:

message - The message to store

truncate

public void truncate()
              throws java.lang.Exception

Deletes the queue (to remove the log) and recreates a new queue instance with the same queue name. Also creates the corresponding message producer

Throws:

java.lang.Exception - If the queue can't be deleted

recreate

public void recreate()
              throws java.lang.Exception

Re-create the queue

Throws:

java.lang.Exception - If the creation has failed

stop

public void stop()
          throws java.lang.Exception

Stop the EventLog

Throws:

java.lang.Exception - If the stop failed

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ReplicaEventLog o)

Specified by:

compareTo in interface java.lang.Comparable<ReplicaEventLog>

getPersistentListener

public SyncReplSearchListener getPersistentListener()

Returns:

The listener

setPersistentListener

public void setPersistentListener(SyncReplSearchListener persistentListener)

Set the listener

Parameters:

persistentListener - The listener

getSearchCriteria

public NotificationCriteria getSearchCriteria()

Returns:

The search criteria

setSearchCriteria

public void setSearchCriteria(NotificationCriteria searchCriteria)

Stores the search criteria

Parameters:

searchCriteria - The search criteria

isRefreshNPersist

public boolean isRefreshNPersist()

Returns:

true if the consumer is in Refresh And Persist mode

setRefreshNPersist

public void setRefreshNPersist(boolean refreshNPersist)

Parameters:

refreshNPersist - if true, set the EventLog in Refresh and Persist mode

getId

public int getId()

Returns:

The replica ID

getLastSentCsn

public java.lang.String getLastSentCsn()

Returns:

The last CSN sent by the consumer

setLastSentCsn

public void setLastSentCsn(java.lang.String lastSentCsn)

Update the last Sent CSN. If it's different from the present one, we will set the dirty flag to true, and it will be stored in DIT.

Parameters:

lastSentCsn - The new Sent CSN

getHostName

public java.lang.String getHostName()

Returns:

The consumer Hostname

setHostName

public void setHostName(java.lang.String hostName)

Set the consumer hostname

Parameters:

hostName - The consumer hostname

getSearchFilter

public java.lang.String getSearchFilter()

Returns:

The searchFilter

setSearchFilter

public void setSearchFilter(java.lang.String searchFilter)

Set the searchFilter

Parameters:

searchFilter - The searchFilter

isDirty

public boolean isDirty()

Returns:

True if the consumer is not up to date

setDirty

public void setDirty(boolean dirty)

Set the dirty flag

Parameters:

dirty - The current consumer status

getQueueName

public java.lang.String getQueueName()

Returns:

The queue name

getCursor

public ReplicaJournalCursor getCursor(java.lang.String consumerCsn)
                               throws java.lang.Exception

Parameters:

consumerCsn - the consumer's CSN extracted from cookie

Returns:

A cursor on top of the queue

Throws:

java.lang.Exception - If the cursor can't be created

getName

public java.lang.String getName()

Returns:

the name of this replica log

count

public long count()

Returns:

the number of entries present in the replica log

getMaxIdlePeriod

public long getMaxIdlePeriod()

setMaxIdlePeriod

public void setMaxIdlePeriod(long maxIdlePeriod)

getPurgeThresholdCount

public int getPurgeThresholdCount()

setPurgeThresholdCount

public void setPurgeThresholdCount(int purgeThresholdCount)

getConsumerEntryDn

public org.apache.directory.api.ldap.model.name.Dn getConsumerEntryDn()

setConsumerEntryDn

public void setConsumerEntryDn(org.apache.directory.api.ldap.model.name.Dn consumerEntryDn)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object