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

Class SyncReplSearchListener

java.lang.Object

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

All Implemented Interfaces:

org.apache.directory.api.ldap.model.message.AbandonListener, DirectoryListener

public class SyncReplSearchListener
extends java.lang.Object
implements DirectoryListener, org.apache.directory.api.ldap.model.message.AbandonListener

A listener associated with the replication system. It does send the modifications to the consumer, if it's connected, or store the data into a queue for a later transmission. Note: we always log the entry irrespective of the client's connection status for guaranteed delivery

Field Summary

Fields

Modifier and Type	Field and Description
private ReplicaEventLog	consumerMsgLog The consumer configuration
private static org.slf4j.Logger	LOG Logger for this class
private boolean	pushInRealTime A flag telling if we push the response to the consumer or if we store them in a queue
private static java.lang.String	replConsumerConfigDn
private static java.lang.String	replConsumerDn
private static java.lang.String	schemaDn
private org.apache.directory.api.ldap.model.message.SearchRequest	searchRequest The search request we are processing
private LdapSession	session The ldap session

Constructor Summary

Constructors

Constructor and Description
SyncReplSearchListener(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest searchRequest, ReplicaEventLog consumerMsgLog, boolean pushInRealTime) Create a new instance of a consumer listener

Method Summary

Modifier and Type	Method and Description
private org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue	createControl(DirectoryService directoryService, org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum operation, org.apache.directory.api.ldap.model.entry.Entry entry) Create the SyncStateValue control
void	entryAdded(AddOperationContext addContext) Process a ADD operation.
void	entryDeleted(DeleteOperationContext deleteContext) Process a Delete operation.
void	entryModified(ModifyOperationContext modifyContext) Process a Modify operation.
void	entryMoved(MoveOperationContext moveContext) Process a Move operation.
void	entryMovedAndRenamed(MoveAndRenameOperationContext moveAndRenameContext) Process a MoveAndRename operation.
void	entryRenamed(RenameOperationContext renameContext) Process a Rename operation.
private byte[]	getCookie(org.apache.directory.api.ldap.model.entry.Entry entry) Get the cookie from the entry
private void	handleWriteFuture(org.apache.mina.core.future.WriteFuture future, org.apache.directory.api.ldap.model.entry.Entry entry, EventType event) Process the writing of the replicated entry to the consumer
private boolean	isConfigEntry(org.apache.directory.api.ldap.model.entry.Entry entry) checks if the given entry belongs to the ou=config or ou=schema partition We don't replicate those two partitions
private boolean	isMmrConfiguredToReceiver(AbstractChangeOperationContext ctx) checks if the sender of this replication event is setup with MMR (Note: this method is used to prevent sending a replicated event back to the sender after performing local update)
private boolean	isNotValidForReplication(AbstractChangeOperationContext ctx)
boolean	isPushInRealTime()
boolean	isSynchronous() indicates if this listener needs to be invoked synchronously
void	requestAbandoned(org.apache.directory.api.ldap.model.message.AbandonableRequest searchRequest) Abandon a SearchRequest
private void	sendDeletedEntry(org.apache.directory.api.ldap.model.entry.Entry entry) A helper method, as the delete opertaionis used by the ModDN operations.
private void	sendResult(org.apache.directory.api.ldap.model.message.SearchResultEntry searchResultEntry, org.apache.directory.api.ldap.model.entry.Entry entry, EventType eventType, org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue syncStateValue) Send the result to the consumer.
void	setPushInRealTime(boolean pushInRealTime) Set the pushInRealTime parameter
void	setSearchRequest(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest) Stores the SearchRequest, and associate a AbandonListener to it
void	setSession(LdapSession session) Store the Ldap session to use
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Logger for this class

session

private LdapSession session

The ldap session

searchRequest

private org.apache.directory.api.ldap.model.message.SearchRequest searchRequest

The search request we are processing

pushInRealTime

private volatile boolean pushInRealTime

A flag telling if we push the response to the consumer or if we store them in a queue

consumerMsgLog

private final ReplicaEventLog consumerMsgLog

The consumer configuration

replConsumerConfigDn

private static java.lang.String replConsumerConfigDn

schemaDn

private static java.lang.String schemaDn

replConsumerDn

private static java.lang.String replConsumerDn

Constructor Detail

SyncReplSearchListener

SyncReplSearchListener(LdapSession session,
                       org.apache.directory.api.ldap.model.message.SearchRequest searchRequest,
                       ReplicaEventLog consumerMsgLog,
                       boolean pushInRealTime)

Create a new instance of a consumer listener

Parameters:

session - The LDAP session to use for this listener

searchRequest - The searchRequest to process

consumerMsgLog - The consumer configuration

pushInRealTime - Tells if we push the results to the consumer in real time

Method Detail

setSession

public void setSession(LdapSession session)

Store the Ldap session to use

Parameters:

session - The Ldap Session to use

setSearchRequest

public void setSearchRequest(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)

Stores the SearchRequest, and associate a AbandonListener to it

Parameters:

searchRequest - The SearchRequest instance to store

isSynchronous

public boolean isSynchronous()

Description copied from interface: DirectoryListener

indicates if this listener needs to be invoked synchronously

Specified by:

isSynchronous in interface DirectoryListener

Returns:

true if should be invoked synchronously, false otherwise

requestAbandoned

public void requestAbandoned(org.apache.directory.api.ldap.model.message.AbandonableRequest searchRequest)

Abandon a SearchRequest

Specified by:

requestAbandoned in interface org.apache.directory.api.ldap.model.message.AbandonListener

Parameters:

searchRequest - The SearchRequest to abandon

createControl

private org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue createControl(DirectoryService directoryService,
                                                                                                      org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum operation,
                                                                                                      org.apache.directory.api.ldap.model.entry.Entry entry)
                                                                                               throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

Create the SyncStateValue control

Throws:

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

sendResult

private void sendResult(org.apache.directory.api.ldap.model.message.SearchResultEntry searchResultEntry,
                        org.apache.directory.api.ldap.model.entry.Entry entry,
                        EventType eventType,
                        org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue syncStateValue)

Send the result to the consumer. If the consumer has disconnected, we fail back to the queue.

entryAdded

public void entryAdded(AddOperationContext addContext)

Process a ADD operation. The added entry is pushed to the consumer if it's connected, or stored in the consumer's queue if it's not.

Specified by:

entryAdded in interface DirectoryListener

Parameters:

addContext - The Addition operation context

entryDeleted

public void entryDeleted(DeleteOperationContext deleteContext)

Process a Delete operation. A delete event is send to the consumer, or stored in its queue if the consumer is not connected.

Specified by:

entryDeleted in interface DirectoryListener

Parameters:

deleteContext - The delete operation context

sendDeletedEntry

private void sendDeletedEntry(org.apache.directory.api.ldap.model.entry.Entry entry)

A helper method, as the delete opertaionis used by the ModDN operations.

entryModified

public void entryModified(ModifyOperationContext modifyContext)

Process a Modify operation. A modify event is send to the consumer, or stored in its queue if the consumer is not connected.

Specified by:

entryModified in interface DirectoryListener

Parameters:

modifyContext - The modify operation context

entryMoved

public void entryMoved(MoveOperationContext moveContext)

Process a Move operation. A MODDN event is send to the consumer, or stored in its queue if the consumer is not connected.

Specified by:

entryMoved in interface DirectoryListener

Parameters:

moveContext - The move operation context

entryMovedAndRenamed

public void entryMovedAndRenamed(MoveAndRenameOperationContext moveAndRenameContext)

Process a MoveAndRename operation. A MODDN event is send to the consumer, or stored in its queue if the consumer is not connected.

Specified by:

entryMovedAndRenamed in interface DirectoryListener

Parameters:

moveAndRenameContext - The move and rename operation context

entryRenamed

public void entryRenamed(RenameOperationContext renameContext)

Process a Rename operation. A MODDN event is send to the consumer, or stored in its queue if the consumer is not connected.

Specified by:

entryRenamed in interface DirectoryListener

Parameters:

renameContext - The rename operation context

isPushInRealTime

public boolean isPushInRealTime()

Returns:

true if the entries are sent to the consumer in real time

setPushInRealTime

public void setPushInRealTime(boolean pushInRealTime)

Set the pushInRealTime parameter

Parameters:

pushInRealTime - true if the entries must be push to the consumer directly

getCookie

private byte[] getCookie(org.apache.directory.api.ldap.model.entry.Entry entry)
                  throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

Get the cookie from the entry

Throws:

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

handleWriteFuture

private void handleWriteFuture(org.apache.mina.core.future.WriteFuture future,
                               org.apache.directory.api.ldap.model.entry.Entry entry,
                               EventType event)

Process the writing of the replicated entry to the consumer

isConfigEntry

private boolean isConfigEntry(org.apache.directory.api.ldap.model.entry.Entry entry)

checks if the given entry belongs to the ou=config or ou=schema partition We don't replicate those two partitions

Parameters:

entry - the entry

Returns:

true if the entry belongs to ou=config partition, false otherwise

isNotValidForReplication

private boolean isNotValidForReplication(AbstractChangeOperationContext ctx)

isMmrConfiguredToReceiver

private boolean isMmrConfiguredToReceiver(AbstractChangeOperationContext ctx)

checks if the sender of this replication event is setup with MMR (Note: this method is used to prevent sending a replicated event back to the sender after performing local update)

Parameters:

ctx - the operation's context

Returns:

true if the rid present in operation context is same as the event log's ID, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object