org.apache.directory.server.ldap.replication.consumer

Class ReplicationConsumerImpl

java.lang.Object

org.apache.directory.server.ldap.replication.consumer.ReplicationConsumerImpl

All Implemented Interfaces:

org.apache.directory.ldap.client.api.ConnectionClosedEventListener, ReplicationConsumer

public class ReplicationConsumerImpl
extends java.lang.Object
implements org.apache.directory.ldap.client.api.ConnectionClosedEventListener, ReplicationConsumer

Implementation of syncrepl slave a.k.a consumer.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.schema.AttributeType	adsDsReplicaIdAT
private org.apache.directory.api.ldap.model.schema.AttributeType	adsReplCookieAT AttributeTypes used for replication
private SyncReplConfiguration	config the syncrepl configuration
private org.apache.directory.ldap.client.api.LdapNetworkConnection	connection connection to the syncrepl provider
private static org.slf4j.Logger	CONSUMER_LOG A dedicated logger for the consumer
private org.apache.directory.api.ldap.model.entry.Modification	cookieMod
private DirectoryService	directoryService a reference to the directoryService
private boolean	disconnected flag to indicate whether the consumer was disconnected
private static org.apache.directory.api.ldap.model.filter.PresenceNode	ENTRY_UUID_PRESENCE_FILTER The (entrtyUuid=*) filter
private byte[]	lastSavedCookie the cookie that was saved last time
private static java.lang.String[]	MOD_IGNORE_AT attributes on which modification should be ignored
private boolean	reload
private org.apache.directory.api.ldap.model.entry.Modification	ridMod
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager the schema manager
private org.apache.directory.api.ldap.model.message.SearchRequest	searchRequest the search request with control
private CoreSession	session the core session
private byte[]	syncCookie the sync cookie sent by the server
private static java.util.Map<java.lang.String,java.lang.Object>	UUID_LOCK_MAP

Fields inherited from interface org.apache.directory.server.ldap.replication.consumer.ReplicationConsumer

DIFFERED, NOW

Constructor Summary

Constructors

Constructor and Description
ReplicationConsumerImpl()

Method Summary

Modifier and Type	Method and Description
private void	applyModDnOperation(org.apache.directory.api.ldap.model.entry.Entry remoteEntry, java.lang.String entryUuid, int rid)
private java.lang.String[]	computeAttributes(java.lang.String[] attributes, java.lang.String addedAttribute) Create a new list combining a list and a newly added attribute
boolean	connect() Connect to the remote server.
boolean	connect(boolean now) Connect the consumer, connection immediately or wait before reconnection
void	connectionClosed()
private void	deleteEntries(java.util.List<byte[]> uuidList, boolean isRefreshPresent, int replicaId) deletes the entries having the UUID given in the list
private void	deleteRecursive(org.apache.directory.api.ldap.model.name.Dn rootDn, int rid) removes all child entries present under the given Dn and finally the Dn itself
private void	disconnect() Disconnect from the producer
private ReplicationStatusEnum	doRefreshOnly()
private ReplicationStatusEnum	doSyncSearch(org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum syncType, boolean reloadHint) Performs a search on connection with updated syncRequest control.
SyncReplConfiguration	getConfig()
java.lang.String	getId()
private java.lang.Object	getLockFor(java.lang.String uuid)
private void	handleSearchReference(org.apache.directory.api.ldap.model.message.SearchResultReference searchRef)
private org.apache.directory.api.ldap.model.message.ResultCodeEnum	handleSearchResultDone(org.apache.directory.api.ldap.model.message.SearchResultDone searchDone)
private void	handleSearchResultEntry(org.apache.directory.api.ldap.model.message.SearchResultEntry syncResult) Process a SearchResultEntry received from a consumer.
private void	handleSyncInfo(org.apache.directory.api.ldap.model.message.IntermediateResponse syncInfoResp)
void	init(DirectoryService directoryservice) Init the replication service
private void	modify(org.apache.directory.api.ldap.model.entry.Entry remoteEntry, int rid)
void	ping() Test the connection with the provider.
private void	prepareSyncSearchRequest() prepares a SearchRequest for syncing DIT content.
private void	processDelete(java.util.List<byte[]> limitedUuidList, boolean isRefreshPresent, int replicaId) do not call this method directly, instead call deleteEntries()
private void	readCookie() Read the cookie for a consumer
private void	removeCookie() deletes the cookie and resets the syncCookie to null
void	setConfig(ReplicationConsumerConfig config) Sets the configuration of the consumer
ReplicationStatusEnum	startSync() Starts the synchronization operation
void	stop() Stops the consumer
private void	storeCookie() stores the cookie.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONSUMER_LOG

private static final org.slf4j.Logger CONSUMER_LOG

A dedicated logger for the consumer

config

private SyncReplConfiguration config

the syncrepl configuration

syncCookie

private byte[] syncCookie

the sync cookie sent by the server

connection

private org.apache.directory.ldap.client.api.LdapNetworkConnection connection

connection to the syncrepl provider

searchRequest

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

the search request with control

directoryService

private DirectoryService directoryService

a reference to the directoryService

schemaManager

private org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

the schema manager

disconnected

private volatile boolean disconnected

flag to indicate whether the consumer was disconnected

session

private CoreSession session

the core session

MOD_IGNORE_AT

private static final java.lang.String[] MOD_IGNORE_AT

attributes on which modification should be ignored

lastSavedCookie

private byte[] lastSavedCookie

the cookie that was saved last time

reload

private volatile boolean reload

ENTRY_UUID_PRESENCE_FILTER

private static final org.apache.directory.api.ldap.model.filter.PresenceNode ENTRY_UUID_PRESENCE_FILTER

The (entrtyUuid=*) filter

cookieMod

private org.apache.directory.api.ldap.model.entry.Modification cookieMod

ridMod

private org.apache.directory.api.ldap.model.entry.Modification ridMod

adsReplCookieAT

private org.apache.directory.api.ldap.model.schema.AttributeType adsReplCookieAT

AttributeTypes used for replication

adsDsReplicaIdAT

private org.apache.directory.api.ldap.model.schema.AttributeType adsDsReplicaIdAT

UUID_LOCK_MAP

private static final java.util.Map<java.lang.String,java.lang.Object> UUID_LOCK_MAP

Constructor Detail

ReplicationConsumerImpl

public ReplicationConsumerImpl()

Method Detail

getConfig

public SyncReplConfiguration getConfig()

Specified by:

getConfig in interface ReplicationConsumer

Returns:

the config

init

public void init(DirectoryService directoryservice)
          throws java.lang.Exception

Init the replication service

Specified by:

init in interface ReplicationConsumer

Parameters:

directoryservice - The directory service

Throws:

java.lang.Exception - If the initialization failed

connect

public boolean connect()

Connect to the remote server. Note that a SyncRepl consumer will be connected to only one remote server

Returns:

true if the connections have been successful.

prepareSyncSearchRequest

private void prepareSyncSearchRequest()
                               throws org.apache.directory.api.ldap.model.exception.LdapException

prepares a SearchRequest for syncing DIT content.

Throws:

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

handleSearchResultDone

private org.apache.directory.api.ldap.model.message.ResultCodeEnum handleSearchResultDone(org.apache.directory.api.ldap.model.message.SearchResultDone searchDone)

handleSearchReference

private void handleSearchReference(org.apache.directory.api.ldap.model.message.SearchResultReference searchRef)

handleSearchResultEntry

private void handleSearchResultEntry(org.apache.directory.api.ldap.model.message.SearchResultEntry syncResult)

Process a SearchResultEntry received from a consumer. We have to handle all the cases : - Add - Modify - Moddn - Delete - Present

Parameters:

syncResult -

handleSyncInfo

private void handleSyncInfo(org.apache.directory.api.ldap.model.message.IntermediateResponse syncInfoResp)

connectionClosed

public void connectionClosed()

Specified by:

connectionClosed in interface org.apache.directory.ldap.client.api.ConnectionClosedEventListener

startSync

public ReplicationStatusEnum startSync()

Starts the synchronization operation

Specified by:

startSync in interface ReplicationConsumer

doRefreshOnly

private ReplicationStatusEnum doRefreshOnly()

setConfig

public void setConfig(ReplicationConsumerConfig config)

Sets the configuration of the consumer

Specified by:

setConfig in interface ReplicationConsumer

Parameters:

config - the configuration of the consumer

connect

public boolean connect(boolean now)

Connect the consumer, connection immediately or wait before reconnection

Specified by:

connect in interface ReplicationConsumer

Parameters:

now - A param that tells the consumer to connect immediately or not

Returns:

true if the consumer is connected, false otherwise

ping

public void ping()

Test the connection with the provider. It does connect to the provider, and tries to bind on it using the consumer credentials.

Specified by:

ping in interface ReplicationConsumer

stop

public void stop()

Stops the consumer

Specified by:

stop in interface ReplicationConsumer

getId

public java.lang.String getId()

Specified by:

getId in interface ReplicationConsumer

Returns:

the identifier of the consumer instance

doSyncSearch

private ReplicationStatusEnum doSyncSearch(org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum syncType,
                                           boolean reloadHint)
                                    throws java.lang.Exception

Performs a search on connection with updated syncRequest control. The provider will initiate an UpdateContant or an initContent depending on the current consumer status, accordingly to the cookie's content. If the mode is refreshOnly, the server will send a SearchResultDone when all the modified entries have been sent. If the mode is refreshAndPersist, the provider never send a SearchResultDone, so we keep receiving modifications' notifications on the consumer, and never exit the loop, unless some communication error occurs.

Parameters:

syncType - The synchornization type, either REFRESH_ONLY or REFRESH_AND_PERSIST

reloadHint - A flag used to tell the server that we want a reload

Returns:

The replication status

Throws:

java.lang.Exception - in case of any problems encountered while searching

disconnect

private void disconnect()

Disconnect from the producer

storeCookie

private void storeCookie()

stores the cookie.

readCookie

private void readCookie()

Read the cookie for a consumer

removeCookie

private void removeCookie()

deletes the cookie and resets the syncCookie to null

applyModDnOperation

private void applyModDnOperation(org.apache.directory.api.ldap.model.entry.Entry remoteEntry,
                                 java.lang.String entryUuid,
                                 int rid)
                          throws java.lang.Exception

Throws:

java.lang.Exception

modify

private void modify(org.apache.directory.api.ldap.model.entry.Entry remoteEntry,
                    int rid)
             throws java.lang.Exception

Throws:

java.lang.Exception

computeAttributes

private java.lang.String[] computeAttributes(java.lang.String[] attributes,
                                             java.lang.String addedAttribute)

Create a new list combining a list and a newly added attribute

deleteEntries

private void deleteEntries(java.util.List<byte[]> uuidList,
                           boolean isRefreshPresent,
                           int replicaId)
                    throws java.lang.Exception

deletes the entries having the UUID given in the list

Parameters:

uuidList - the list of UUIDs

replicaId - TODO

Throws:

java.lang.Exception - in case of any problems while deleting the entries

processDelete

private void processDelete(java.util.List<byte[]> limitedUuidList,
                           boolean isRefreshPresent,
                           int replicaId)
                    throws java.lang.Exception

do not call this method directly, instead call deleteEntries()

Parameters:

limitedUuidList - a list of UUIDs whose size is less than or equal to #NODE_LIMIT (node limit applies only for refreshDeletes list)

isRefreshPresent - a flag indicating the type of entries present in the UUID list

replicaId - TODO

Throws:

java.lang.Exception

getLockFor

private java.lang.Object getLockFor(java.lang.String uuid)

deleteRecursive

private void deleteRecursive(org.apache.directory.api.ldap.model.name.Dn rootDn,
                             int rid)
                      throws java.lang.Exception

removes all child entries present under the given Dn and finally the Dn itself

Parameters:

rootDn - the Dn which will be removed after removing its children

rid - the replica ID

Throws:

java.lang.Exception - If the Dn is not valid or if the deletion failed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()