Package org.forgerock.opendj.server.leaderbasedreplication

Class ReplicaClient

java.lang.Object

org.forgerock.opendj.server.leaderbasedreplication.ReplicaClient

public class ReplicaClient
extends Object

Represents a client that interacts with a remote replica, either regular or providing the Core feature.

Three operations are provided:

• Fetch changes from a replica: fetchChangesFromReplica()
• Register to the core: registerToCore()
• Fetch the topology from the core: ReplicaClient#fetchTopologyFromCore()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ReplicaClient.ChangelogAndDomainStates	Represents the changelog state and the domain state (SCP and PP) for a given domain.
static final record	ReplicaClient.RegistrationToCoreRequest	Represents information that a replica must provide to register to the core regularly.
static final record	ReplicaClient.RegistrationToCoreResponse	Represents the information that is returned upon a ReplicaClient.RegistrationToCoreRequest sent by a replica to the core.

Constructor Summary

Constructors

Constructor	Description
ReplicaClient()

Method Summary

Modifier and Type	Method	Description
Result	fetchChangesFromReplica(ReplicaId replicaId, Connection replicaConnection, Set<ReplicaClient.ChangelogAndDomainStates> domainStates, SearchResultHandler searchResultHandler, String logContext)	Fetches changes from a remote replica.
Topology	fetchTopologyFromCore(Connection coreConnection)	Fetches the topology from the core.
static void	logChangelogEntry(SearchResultEntry searchResultEntry, String logContext)	Logs the provided changelog entry.
ReplicaClient.RegistrationToCoreResponse	registerToCore(Connection coreConnection, ReplicaClient.RegistrationToCoreRequest request)	Registers a replica to the core.

Methods inherited from class java.lang.Object

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

Constructor Details

ReplicaClient

public ReplicaClient()

Method Details

fetchChangesFromReplica

public Result fetchChangesFromReplica(ReplicaId replicaId,
 Connection replicaConnection,
 Set<ReplicaClient.ChangelogAndDomainStates> domainStates,
 SearchResultHandler searchResultHandler,
 String logContext)
                               throws LdapException

Fetches changes from a remote replica.

Parameters:

replicaId - the replica id

replicaConnection - the connection to the replica

domainStates - the states of the domains to fetch

searchResultHandler - the handler to process the search results

logContext - provides context for logging (originator of the request)

Returns:

the result of the search

Throws:

LdapException - if an error occurs while fetching the changes

registerToCore

public ReplicaClient.RegistrationToCoreResponse registerToCore(Connection coreConnection,
 ReplicaClient.RegistrationToCoreRequest request)
                                                        throws LdapException

Registers a replica to the core.

Parameters:

coreConnection - the connection to the core

request - the registration request from the replica

Returns:

the response from the core

Throws:

LdapException - if an error occurs while registering to the core

fetchTopologyFromCore

public Topology fetchTopologyFromCore(Connection coreConnection)
                               throws LdapException

Fetches the topology from the core.

Parameters:

coreConnection - the connection to the core

Returns:

the topology

Throws:

LdapException - if an error occurs while fetching the topology

logChangelogEntry

public static void logChangelogEntry(SearchResultEntry searchResultEntry,
 String logContext)

Logs the provided changelog entry.

Parameters:

searchResultEntry - the changelog entry

logContext - provides context for logging (originator of the request)