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

Class ReplicaJournalCursor

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<ReplicaEventMessage>

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

All Implemented Interfaces:

java.lang.Iterable<ReplicaEventMessage>, org.apache.directory.api.ldap.model.cursor.Cursor<ReplicaEventMessage>

public class ReplicaJournalCursor
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<ReplicaEventMessage>

Define a cursor on top of a replication journal.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	consumerCsn the consumer's CSN based on which messages will be qualified for sending
private static boolean	IS_DEBUG Speedup for logs
private JdbmTable<java.lang.String,ReplicaEventMessage>	journal the event log journal
private static org.slf4j.Logger	LOG Logger for this class
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private ReplicaEventMessage	qualifiedEvtMsg
private boolean	skipQualifying used while cleaning up the log
private org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<java.lang.String,ReplicaEventMessage>>	tupleCursor the underlying journal's cursor

Constructor Summary

Constructors

Constructor and Description
ReplicaJournalCursor(JdbmTable<java.lang.String,ReplicaEventMessage> journal, java.lang.String consumerCsn) Creates a cursor on top of the given journal

Method Summary

Modifier and Type	Method and Description
void	after(ReplicaEventMessage arg0)
void	afterLast()
boolean	available()
void	before(ReplicaEventMessage arg0)
void	beforeFirst()
void	close()
void	close(java.lang.Exception cause)
protected void	delete() delete the current message used for internal log cleanup ONLY
boolean	first()
ReplicaEventMessage	get()
private boolean	isQualified(java.lang.String csn, ReplicaEventMessage evtMsg) selects the current queue entry if qualified for sending to the consumer
java.util.Iterator<ReplicaEventMessage>	iterator()
boolean	last()
boolean	next()
boolean	previous()
protected void	skipQualifyingWhileFetching() sets the flag to skip CSN based checking while traversing used for internal log cleanup ONLY

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, setClosureMonitor, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG

private static final org.slf4j.Logger LOG

Logger for this class

LOG_CURSOR

private static final org.slf4j.Logger LOG_CURSOR

A dedicated log for cursors

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

tupleCursor

private org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<java.lang.String,ReplicaEventMessage>> tupleCursor

the underlying journal's cursor

journal

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

the event log journal

consumerCsn

private java.lang.String consumerCsn

the consumer's CSN based on which messages will be qualified for sending

qualifiedEvtMsg

private ReplicaEventMessage qualifiedEvtMsg

skipQualifying

private boolean skipQualifying

used while cleaning up the log

Constructor Detail

ReplicaJournalCursor

public ReplicaJournalCursor(JdbmTable<java.lang.String,ReplicaEventMessage> journal,
                            java.lang.String consumerCsn)
                     throws java.lang.Exception

Creates a cursor on top of the given journal

Parameters:

journal - the log journal

consumerCsn - the consumer's CSN taken from cookie

Throws:

java.lang.Exception

Method Detail

after

public void after(ReplicaEventMessage arg0)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

available

public boolean available()

before

public void before(ReplicaEventMessage arg0)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

get

public ReplicaEventMessage get()
                        throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.cursor.CursorException

isQualified

private boolean isQualified(java.lang.String csn,
                            ReplicaEventMessage evtMsg)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

selects the current queue entry if qualified for sending to the consumer

Throws:

java.lang.Exception

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

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

org.apache.directory.api.ldap.model.cursor.CursorException

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<ReplicaEventMessage>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<ReplicaEventMessage>

close

public void close(java.lang.Exception cause)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<ReplicaEventMessage>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<ReplicaEventMessage>

skipQualifyingWhileFetching

protected void skipQualifyingWhileFetching()

sets the flag to skip CSN based checking while traversing used for internal log cleanup ONLY

delete

protected void delete()

delete the current message used for internal log cleanup ONLY

iterator

public java.util.Iterator<ReplicaEventMessage> iterator()

Specified by:

iterator in interface java.lang.Iterable<ReplicaEventMessage>

Overrides:

iterator in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<ReplicaEventMessage>