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

All Known Implementing Classes:

ReplicationConsumerImpl

public interface ReplicationConsumer

An interface for providers of a service which receives the ldap entries as and when a event happens in the server. The data received might vary based on the internal configuration used by implementation.

Author:

Apache Directory Project

Method Summary

ReplicationConsumerConfig	getConfig()
String	getId() the identifier of this consumer instance
void	init(DirectoryService dirService) initializes the consumer
void	setConfig(ReplicationConsumerConfig config) sets the configuration of the consumer
void	start() starts the consumer
void	stop() stops the consumer

Method Detail

setConfig

void setConfig(ReplicationConsumerConfig config)

sets the configuration of the consumer

Parameters:

config - the configuration of the consumer

getConfig

ReplicationConsumerConfig getConfig()

Returns:

get the configuration of the consumer

init

void init(DirectoryService dirService)
          throws Exception

initializes the consumer

Parameters:

dirService - the DirectoryService

Throws:

Exception

start

void start()

starts the consumer

stop

void stop()

stops the consumer

getId

String getId()

the identifier of this consumer instance

Returns:

the identifier of the consumer instance