Package org.opends.server.discovery

Class ReplicationServiceDiscoveryMechanism

java.lang.Object

org.opends.server.discovery.ReplicationServiceDiscoveryMechanism

All Implemented Interfaces:

ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg>, ServiceDiscoveryMechanism<ReplicationServiceDiscoveryMechanismCfg>

public final class ReplicationServiceDiscoveryMechanism
extends Object
implements ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg>

Service Discovery Mechanism retrieving information from a replication topology.

The partitions returned by this class contain the directory servers that are part of the same topology as the configured replication servers.

It will periodically query the topology to discover any new or removed servers and notify listeners of any changes.

Constructor Summary

Constructors

Constructor	Description
ReplicationServiceDiscoveryMechanism()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(ReplicationServiceDiscoveryMechanismCfg configuration)	Applies the configuration changes to this change listener.
void	deregisterChangeListener(ServiceDiscoveryChangeListener listener)	De-registers a listener from notifications on service changes.
void	finalizeMechanism()	Frees any resources in use, mechanism will not be used anymore afterwards.
protected void	fireConnectionOptionsChanged()
String	getName()	Returns the name of the mechanism.
Partition	getPartition(Collection<Dn> baseDNs)	Returns the partitions.
void	initializeMechanism(ReplicationServiceDiscoveryMechanismCfg config, ServerContext serverContext)	Initializes the mechanism with the provided configuration.
boolean	isConfigurationAcceptable(ReplicationServiceDiscoveryMechanismCfg configuration, List<LocalizableMessage> unacceptableReasons, ServerContext serverContext)	Returns whether the provided configuration is correct for the mechanism.
boolean	isConfigurationChangeAcceptable(ReplicationServiceDiscoveryMechanismCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
void	registerChangeListener(ServiceDiscoveryChangeListener listener)	Registers a listener to be notified when changes in the service occur.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicationServiceDiscoveryMechanism

public ReplicationServiceDiscoveryMechanism()

Method Detail

initializeMechanism

public void initializeMechanism(ReplicationServiceDiscoveryMechanismCfg config,
                                ServerContext serverContext)

Description copied from interface: ServiceDiscoveryMechanism

Initializes the mechanism with the provided configuration.

Specified by:

initializeMechanism in interface ServiceDiscoveryMechanism<ReplicationServiceDiscoveryMechanismCfg>

Parameters:

config - the configuration for initialization

serverContext - the server context for this Directory Server instance

getPartition

public Partition getPartition(Collection<Dn> baseDNs)

Description copied from interface: ServiceDiscoveryMechanism

Returns the partitions.

Each Partition will only contain servers that are known to expose the provided list of base DNs. An empty list of base DNs will result in all partitions and all servers being returned. In other words, an empty list of base DNs implies that all servers contain exactly the same base DNs.

Specified by:

getPartition in interface ServiceDiscoveryMechanism<ReplicationServiceDiscoveryMechanismCfg>

Parameters:

baseDNs - the baseDNs for which to retrieve the partitions

Returns:

the partitions that can serve the provided base DNs

isConfigurationAcceptable

public boolean isConfigurationAcceptable(ReplicationServiceDiscoveryMechanismCfg configuration,
                                         List<LocalizableMessage> unacceptableReasons,
                                         ServerContext serverContext)

Description copied from interface: ServiceDiscoveryMechanism

Returns whether the provided configuration is correct for the mechanism. It should be possible to call this method on an uninitialized mechanism to check the configuration for correctness.

Specified by:

isConfigurationAcceptable in interface ServiceDiscoveryMechanism<ReplicationServiceDiscoveryMechanismCfg>

Parameters:

configuration - the configuration to check

unacceptableReasons - the list of reasons the configuration is not acceptable

serverContext - the server context of this Directory Server instance

Returns:

if the provided configuration is correct for the mechanism.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(ReplicationServiceDiscoveryMechanismCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(ReplicationServiceDiscoveryMechanismCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

getName

public final String getName()

Description copied from interface: ServiceDiscoveryMechanism

Returns the name of the mechanism.

Specified by:

getName in interface ServiceDiscoveryMechanism<C extends ServiceDiscoveryMechanismCfg>

Returns:

the name of the mechanism

finalizeMechanism

public final void finalizeMechanism()

Description copied from interface: ServiceDiscoveryMechanism

Frees any resources in use, mechanism will not be used anymore afterwards.

Specified by:

finalizeMechanism in interface ServiceDiscoveryMechanism<C extends ServiceDiscoveryMechanismCfg>

fireConnectionOptionsChanged

protected final void fireConnectionOptionsChanged()

registerChangeListener

public final void registerChangeListener(ServiceDiscoveryChangeListener listener)

Description copied from interface: ServiceDiscoveryMechanism

Registers a listener to be notified when changes in the service occur.

Specified by:

registerChangeListener in interface ServiceDiscoveryMechanism<C extends ServiceDiscoveryMechanismCfg>

Parameters:

listener - the listener to register for notifications

deregisterChangeListener

public final void deregisterChangeListener(ServiceDiscoveryChangeListener listener)

Description copied from interface: ServiceDiscoveryMechanism

De-registers a listener from notifications on service changes.

Specified by:

deregisterChangeListener in interface ServiceDiscoveryMechanism<C extends ServiceDiscoveryMechanismCfg>

Parameters:

listener - the listener to de-register

toString

public String toString()

Overrides:

toString in class Object