Package com.qfs.messenger

Interface IDistributedHierarchyManager

All Superinterfaces:

IAgent, IDistributedAgent, IExtendedPluginValue, IMonitoredComponent

All Known Implementing Classes:

DistributedHierarchyManager

public interface IDistributedHierarchyManager
extends IMonitoredComponent, IDistributedAgent

Component of cube of query that can handle IInitialDiscoveryMessage, ITransactionCommittedMessage or members (cube of data) leaving the cluster and apply associated changes into the cube.

Author:

ActiveViam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IDistributedHierarchyManager.IDistributedExceptionHandler	Interface for exception handlers to process an exception raised when consuming a message.

Nested classes/interfaces inherited from interface com.quartetfs.fwk.IAgent

IAgent.ITransition, IAgent.State

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_PLUGIN_KEY	The plugin key of the default implementation.

Method Summary

Modifier and Type	Method	Description
void	applyGoodbyeMessageRemovalAsync(GoodbyeMessage message)	Immediately triggers the removal task for the member broadcasting the received message.
void	applyInitialDiscoveryMessageAsync(IInitialDiscoveryMessage discoveryMessage)	Applies the response to an initial discovery message and updates the current view ID to the given one (IInitialDiscoveryMessage.getViewId()).
void	applyInitialDiscoveryMessageAsync(CompositeDiscoveryMessage compositeDiscoveryMessage)	Applies the response to an initial discovery message and updates the current view ID to the given one (IInitialDiscoveryMessage.getViewId()).
void	applyRemoteTransactionAsync(ITransactionCommittedMessage message)	Applies asynchronously, but in the required order, the data associated with the given remote transaction.
boolean	canReceiveDiscoveryMessage(String remoteAddress)	Returns whether this manager can receive an additional initial discovery message from the given data cube.
IEpoch	getMostRecentAcknowledgedEpoch(String remoteAddress, long viewId)	Returns the last known epoch of the remote cube or null if no message between the two instances has been sent & applied.
IMultiVersionDistributedActivePivot	getPivot()	Returns the QUERY cube the manager belongs to.
boolean	isDiscoveryApplied(String applicationId)	Returns true if the schema of this application has already been received and applied.
void	waitForAllMessages(long timeoutMillis)	Waits for all the query node messages to be processed.

Methods inherited from interface com.quartetfs.fwk.IAgent

getProperties, getStatus, init, pause, resume, start, stop

Methods inherited from interface com.qfs.messenger.IDistributedAgent

onMembersChanged

Methods inherited from interface com.quartetfs.fwk.types.IExtendedPluginValue

getType

Methods inherited from interface com.quartetfs.fwk.monitoring.IMonitoredComponent

getAvailableAttributes, getAvailableOperations, getMonitoredChildren, getStatistics

Field Detail

DEFAULT_PLUGIN_KEY

static final String DEFAULT_PLUGIN_KEY

The plugin key of the default implementation.

See Also:

Constant Field Values

Method Detail

getPivot

IMultiVersionDistributedActivePivot getPivot()

Returns the QUERY cube the manager belongs to.

applyInitialDiscoveryMessageAsync

void applyInitialDiscoveryMessageAsync(CompositeDiscoveryMessage compositeDiscoveryMessage)

Applies the response to an initial discovery message and updates the current view ID to the given one (IInitialDiscoveryMessage.getViewId()). This is done asynchronously.

Parameters:

compositeDiscoveryMessage - the message to apply that contains informations about a remote data cube

applyInitialDiscoveryMessageAsync

void applyInitialDiscoveryMessageAsync(IInitialDiscoveryMessage discoveryMessage)

Applies the response to an initial discovery message and updates the current view ID to the given one (IInitialDiscoveryMessage.getViewId()). This is done asynchronously.

Parameters:

discoveryMessage - the message to apply that contains informations about a remote data cube

applyRemoteTransactionAsync

void applyRemoteTransactionAsync(ITransactionCommittedMessage message)

Applies asynchronously, but in the required order, the data associated with the given remote transaction.

Parameters:

message - The ITransactionCommittedMessage that represents the remote commit

applyGoodbyeMessageRemovalAsync

void applyGoodbyeMessageRemovalAsync(GoodbyeMessage message)

Immediately triggers the removal task for the member broadcasting the received message.

Parameters:

message - The GoodbyeMessage notifying that a remote instance is leaving the cluster

getMostRecentAcknowledgedEpoch

IEpoch getMostRecentAcknowledgedEpoch(String remoteAddress,
                                      long viewId)

Returns the last known epoch of the remote cube or null if no message between the two instances has been sent & applied.

Parameters:

remoteAddress - the address of the remote instance (cube of data)

viewId - the view id of the HelloMessage

isDiscoveryApplied

boolean isDiscoveryApplied(String applicationId)

Returns true if the schema of this application has already been received and applied.

Parameters:

applicationId - the id of an application

canReceiveDiscoveryMessage

boolean canReceiveDiscoveryMessage(String remoteAddress)

Returns whether this manager can receive an additional initial discovery message from the given data cube.

If there are too many pending initial discoveries, this method will return false and the data cube should retry later.

Parameters:

remoteAddress - The address of the data cube

Returns:

true if we can accept an initial discovery from this data cube, false otherwise

waitForAllMessages

void waitForAllMessages(long timeoutMillis)
                 throws TimeoutException,
                        InterruptedException

Waits for all the query node messages to be processed.

Parameters:

timeoutMillis - Maximum time to wait in Milliseconds

Throws:

InterruptedException - If issue with Thread.sleep()

TimeoutException - If waited longer than maximum provided timeoutMillis.