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

Class ReplConsumerManager

java.lang.Object

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

public class ReplConsumerManager
extends java.lang.Object

Manage the consumers on the provider : add them, and remove them. All the consumers configuration will be stored in the 'ou=consumers,ou=system' branch.

Field Summary

Fields

Modifier and Type	Field and Description
private CoreSession	adminSession The admin session used to commuicate with the backend
private org.apache.directory.api.ldap.model.schema.AttributeType	adsReplLastSentCsn An AdsReplLastSentCsn AT instance
private static java.lang.String	CONSUMERS The consumers' ou value
private DirectoryService	directoryService The DirectoryService instance
private static org.slf4j.Logger	LOG Logger for this class
private java.util.Map<java.lang.Integer,org.apache.directory.api.ldap.model.entry.Modification>	modMap A map containing the last sent CSN for every connected consumer
private static org.slf4j.Logger	PROVIDER_LOG A logger for the replication provider
private static java.lang.String	REPL_CONSUMER_DN_STR The replication factory DN
private org.apache.directory.api.ldap.model.name.Dn	replConsumerDn
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The schema manager instance

Constructor Summary

Constructors

Constructor and Description
ReplConsumerManager(DirectoryService directoryService) Create a new instance of the producer replication manager.

Method Summary

Modifier and Type	Method and Description
void	addConsumerEntry(ReplicaEventLog replica) Add a new consumer entry in ou=consumers,ou=system
private ReplicaEventLog	convertEntryToReplica(org.apache.directory.api.ldap.model.entry.Entry entry) Convert the stored entry to a valid ReplicaEventLog structure
private void	createConsumersBranch() Initialize the replication Store, creating the ou=consumers,ou=system entry (only if it does not exist yet)
void	deleteConsumerEntry(ReplicaEventLog replica) Delete an existing consumer entry from ou=consumers,ou=system
java.util.List<ReplicaEventLog>	getReplicaEventLogs() Get the list of consumers' configuration
void	updateReplicaLastSentCsn(ReplicaEventLog replica) Store the new CSN sent by the consumer in place of the previous one.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Logger for this class

PROVIDER_LOG

private static final org.slf4j.Logger PROVIDER_LOG

A logger for the replication provider

adminSession

private CoreSession adminSession

The admin session used to commuicate with the backend

directoryService

private DirectoryService directoryService

The DirectoryService instance

schemaManager

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

The schema manager instance

REPL_CONSUMER_DN_STR

private static final java.lang.String REPL_CONSUMER_DN_STR

The replication factory DN

See Also:

Constant Field Values

replConsumerDn

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

CONSUMERS

private static final java.lang.String CONSUMERS

The consumers' ou value

See Also:

Constant Field Values

adsReplLastSentCsn

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

An AdsReplLastSentCsn AT instance

modMap

private java.util.Map<java.lang.Integer,org.apache.directory.api.ldap.model.entry.Modification> modMap

A map containing the last sent CSN for every connected consumer

Constructor Detail

ReplConsumerManager

public ReplConsumerManager(DirectoryService directoryService)
                    throws java.lang.Exception

Create a new instance of the producer replication manager.

Parameters:

directoryService - The directoryService instance

Throws:

java.lang.Exception - if we add an error while creating the configuration

Method Detail

createConsumersBranch

private void createConsumersBranch()
                            throws java.lang.Exception

Initialize the replication Store, creating the ou=consumers,ou=system entry (only if it does not exist yet)

Throws:

java.lang.Exception

addConsumerEntry

public void addConsumerEntry(ReplicaEventLog replica)
                      throws java.lang.Exception

Add a new consumer entry in ou=consumers,ou=system

Parameters:

replica - The added consumer replica

Throws:

java.lang.Exception - If the addition failed

deleteConsumerEntry

public void deleteConsumerEntry(ReplicaEventLog replica)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Delete an existing consumer entry from ou=consumers,ou=system

Parameters:

replica - The added consumer replica

Throws:

java.lang.Exception - If the addition failed

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

updateReplicaLastSentCsn

public void updateReplicaLastSentCsn(ReplicaEventLog replica)
                              throws java.lang.Exception

Store the new CSN sent by the consumer in place of the previous one.

Parameters:

replica - The consumer informations

Throws:

java.lang.Exception - If the update failed

getReplicaEventLogs

public java.util.List<ReplicaEventLog> getReplicaEventLogs()
                                                    throws java.lang.Exception

Get the list of consumers' configuration

Returns:

A list of all the consumer configuration stored on the provider

Throws:

java.lang.Exception - If we had an error while building this list

convertEntryToReplica

private ReplicaEventLog convertEntryToReplica(org.apache.directory.api.ldap.model.entry.Entry entry)
                                       throws java.lang.Exception

Convert the stored entry to a valid ReplicaEventLog structure

Throws:

java.lang.Exception