Package com.qfs.distribution

Interface IMultiVersionDistributedActivePivot

All Superinterfaces:

IAgent, IContinuouslyQueryable, IExtendedPluginValue, IHasId, IMemoryMonitored, IMultiVersion, IMultiVersionActivePivot, IMultiVersionOperations, IQueryable, IRebuildable<IActivePivotVersion>, ITransactionalMultiVersion

All Known Implementing Classes:

MultiVersionDistributedActivePivot

public interface IMultiVersionDistributedActivePivot
extends IMultiVersionActivePivot

A distributed IMultiVersionActivePivot.

Author:

ActiveViam

Nested Class Summary

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

IAgent.ITransition, IAgent.State

Field Summary

Fields

Modifier and Type	Field	Description
static String	PLUGIN_KEY	Plugin Key.

Fields inherited from interface com.quartetfs.biz.pivot.IMultiVersionActivePivot

AGGREGATE_PROVIDER, AGGREGATES_CACHE, CONTINUOUS_QUERY_ENGINE, DATA_TYPE, DEFAULT_TYPE, QUERY_MANAGER, QUERY_PLAN

Method Summary

Modifier and Type	Method	Description
default boolean	allDiscoveriesApplied()	Check whether all discoveries have been applied or not.
IActivePivotVersion	commit(IEpoch ignoredEpoch)	Deprecated. since 5.5.0
static IMultiVersionDistributedActivePivot	createPivot(String key, IDistributedActivePivotInstanceDescription distributionDescription, IEpochCreator epochCreator, IAdvancedEpochManager epochManager, IPartitioningManager partitioningManager, ITimeSupplier clock, IBranchPermissionsManager branchPermissionsManager, IDomainDictionaryProvider dictionaryProvider)	Creates an instance of multi-version Distributed ActivePivot of the given key.
Map<String,String>	getClusterMembersRestAddresses()	Computes the physical addresses of all the data cubes, using their identifiers within the cluster and the properties ActiveViamProperty.DATA_CUBE_REST_ENDPOINT_PORT_PROPERTY, ActiveViamProperty.DATA_CUBE_REST_ENDPOINT_SUFFIX_PROPERTY.
IDistributedActivePivotContext	getContext()	Returns the context.
IDistributedActivePivotDescription	getDescription()	Gets the IDistributedActivePivotDescription, that is valid for all versions of the distributed pivot.
Map<String,List<String>>	getDistributedApplicationInformation()	Returns The distributing fields index by their application name.
default Map<String,List<String>>	getDistributedApplicationInformations()	Deprecated, for removal: This API element is subject to removal in a future version. Use getDistributedApplicationInformation() instead
IDistributedHierarchyManager	getDistributedHierarchyManager()	Returns the distributedHierarchyManager used to forward the remote transactions to the pivot.
IAdvancedEpochManager	getEpochManager()	Get the epoch manager of this distributed ActivePivot.
static IFactoryValue<IMultiVersionDistributedActivePivot>	getFactory(String key)	Gets the factory to create IMultiVersionDistributedActivePivot of the given key.
IDistributedActivePivotVersion	getHead()	Get the latest version of the distributed ActivePivot in the master branch.
IDistributedActivePivotVersion	getHead(String branch)	Get the latest version of the distributed ActivePivot in the master branch.
IDistributedMessenger	getMessenger()	Returns The messenger used for communicating with the other instances.
IDistributedActivePivotVersion	getMostRecentVersion()	/!\ For internal use only.
IDistributedActivePivotTransaction	getOrCreateTransaction()	Returns the current transaction. The result is never null contrary to ITransactionalMultiVersion.getTransaction().
IDistributedActivePivotTransaction	getTransaction()	Returns the current transaction.
IDistributedActivePivotVersion	onInitialRemoteCommit(List<? extends IDimension<? extends IHierarchy>> mainDimensions, IEpoch epoch, long viewId, String remoteAddress, String applicationId, String remotePivotId, Properties properties)	Merges the delta dimensions from a remote instance's initial commit into the underlying IDistributedActivePivot's cube's main dimensions and notifies the listeners.
IDistributedActivePivotVersion	onRemoteCommit(List<List<? extends IDimension<? extends IHierarchy>>> contributionDeltas, List<List<? extends IDimension<? extends IHierarchy>>> removalDeltas, IEpoch epoch, long viewId, String remoteAddress, String remotePivotId, Properties properties)	Merges the delta hierarchies from a remote instance's commit into the underlying IDistributedActivePivot's cube's main hierarchies and notifies the listeners.
IDistributedActivePivotVersion	removeMembersFromCube(Set<String> membersToRemove, long viewId, boolean discard)	Removes all the contributions from the given cluster members and notifies the listeners.
boolean	useApplicationMeasureGroups()	Returns the current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_GROUPS property.
boolean	useApplicationMeasureGroupsSuffix()	Returns the current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_GROUPS_SUFFIX property.
boolean	useApplicationMeasureNames()	Returns the current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_NAMES property.

Methods inherited from interface com.quartetfs.fwk.IAgent

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

Methods inherited from interface com.quartetfs.fwk.query.IContinuouslyQueryable

getContinuousQuery, registerContinuousQuery, registerContinuousQuery, registeredContinuousQueryNames, unregisterAllContinuousQueries, unregisterContinuousQuery

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

getType

Methods inherited from interface com.qfs.monitoring.memory.IMemoryMonitored

getMemoryStatistic

Methods inherited from interface com.quartetfs.biz.pivot.IMultiVersionActivePivot

awaitNotifications, awaitNotifications, awaitNotifications, cancelUserQueries, createCompositeTransactionInfo, getAggregatesContinuousQueryEngine, getBranches, getBranchPermissionsManager, getDrillthroughContinuousQueryEngine, getHeads, getHierarchies, getId, getLastActivityTime, getListeners, getMissingLocationsSolver, getReadableBranches, getVersionHistory, isDistributed, setTransactionProperties

Methods inherited from interface com.quartetfs.fwk.query.IQueryable

execute, getSupportedQueries

Methods inherited from interface com.quartetfs.biz.pivot.IRebuildable

rebuild

Methods inherited from interface com.qfs.multiversion.ITransactionalMultiVersion

rollback

Field Detail

PLUGIN_KEY

static final String PLUGIN_KEY

Plugin Key.

See Also:

Constant Field Values

Method Detail

createPivot

static IMultiVersionDistributedActivePivot createPivot(String key,
                                                       IDistributedActivePivotInstanceDescription distributionDescription,
                                                       IEpochCreator epochCreator,
                                                       IAdvancedEpochManager epochManager,
                                                       IPartitioningManager partitioningManager,
                                                       ITimeSupplier clock,
                                                       IBranchPermissionsManager branchPermissionsManager,
                                                       IDomainDictionaryProvider dictionaryProvider)

Creates an instance of multi-version Distributed ActivePivot of the given key.

Parameters:

partitioningManager - manager to use to create new partitionings

clock - time supplier to use to access time in this ActivePivot

dictionaryProvider - the pivot's dictionary provider

getFactory

static IFactoryValue<IMultiVersionDistributedActivePivot> getFactory(String key)

Gets the factory to create IMultiVersionDistributedActivePivot of the given key.

getMostRecentVersion

IDistributedActivePivotVersion getMostRecentVersion()

Description copied from interface: IMultiVersionActivePivot

/!\ For internal use only. Users must use IMultiVersionActivePivot.getHead(String).

Returns the most recent version that exists across all branches. This function may return a shadow version.

Retrieves the latest (i.e. current) version of the object.

Specified by:

getMostRecentVersion in interface IMultiVersion

Specified by:

getMostRecentVersion in interface IMultiVersionActivePivot

Returns:

the latest version of the object

See Also:

IMultiVersionActivePivot.getHead(), IMultiVersionActivePivot.getHead(String)

getHead

IDistributedActivePivotVersion getHead()

Get the latest version of the distributed ActivePivot in the master branch.

IAsOfEpoch context value is ignored and not supported by distributed cubes.
Only IBranch context value is (from AP 5.6 onwards).

Specified by:

getHead in interface IMultiVersionActivePivot

Returns:

latest version

See Also:

IEpoch.MASTER_BRANCH_NAME

getHead

IDistributedActivePivotVersion getHead(String branch)
                                throws UnknownBranchException

Get the latest version of the distributed ActivePivot in the master branch.

IAsOfEpoch context value is ignored and not supported by distributed cubes.

Specified by:

getHead in interface IMultiVersionActivePivot

Parameters:

branch - the name of a branch

Returns:

latest version in the master branch

Throws:

UnknownBranchException - if a branch other than the master one is specified

getTransaction

IDistributedActivePivotTransaction getTransaction()

Description copied from interface: ITransactionalMultiVersion

Returns the current transaction.

Specified by:

getTransaction in interface IMultiVersionActivePivot

Specified by:

getTransaction in interface ITransactionalMultiVersion

Returns:

the current transaction or null when there is no transaction

See Also:

ITransactionalMultiVersion.getOrCreateTransaction()

getOrCreateTransaction

IDistributedActivePivotTransaction getOrCreateTransaction()

Description copied from interface: ITransactionalMultiVersion

Returns the current transaction.
The result is never null contrary to ITransactionalMultiVersion.getTransaction().

THIS METHOD SHOULD BE CALLED ONLY IF IMultiVersionOperations.commit(IEpoch) (or ITransactionalMultiVersion.rollback()) IS GUARANTEED TO BE CALLED otherwise this could cause a memory leak if the transaction holds a version (because the multiversion will keep the transaction).

Specified by:

getOrCreateTransaction in interface IMultiVersionActivePivot

Specified by:

getOrCreateTransaction in interface ITransactionalMultiVersion

Returns:

the current transaction

See Also:

ITransactionalMultiVersion.getTransaction()

getContext

IDistributedActivePivotContext getContext()

Description copied from interface: IMultiVersionActivePivot

Returns the context.

This context applies to all the ActivePivot versions.

Specified by:

getContext in interface IMultiVersionActivePivot

getEpochManager

IAdvancedEpochManager getEpochManager()

Get the epoch manager of this distributed ActivePivot.

Returns:

the epoch manager in use.

commit

@Deprecated
IActivePivotVersion commit(IEpoch ignoredEpoch)

Deprecated.

since 5.5.0

Unsupported method. Use one of the following method instead:

• onInitialRemoteCommit(List, IEpoch, long, String, String, String, Properties)
• onRemoteCommit(List, List, IEpoch, long, String, String, Properties)
• removeMembersFromCube(Set, long, boolean)

Specified by:

commit in interface IMultiVersionActivePivot

Specified by:

commit in interface IMultiVersionOperations

Parameters:

ignoredEpoch - the epoch associated with this commit

Returns:

the version that prevails after this commit (possibly an untouched current version if the commit had absolutely no impact on the state)

onRemoteCommit

IDistributedActivePivotVersion onRemoteCommit(List<List<? extends IDimension<? extends IHierarchy>>> contributionDeltas,
                                              List<List<? extends IDimension<? extends IHierarchy>>> removalDeltas,
                                              IEpoch epoch,
                                              long viewId,
                                              String remoteAddress,
                                              String remotePivotId,
                                              Properties properties)
                                       throws MergeException

Merges the delta hierarchies from a remote instance's commit into the underlying IDistributedActivePivot's cube's main hierarchies and notifies the listeners.

We do not need to send the dimensions because a remote commit does not change the structure of the cube.

This creates a new version of this pivot.

Parameters:

contributionDeltas - contributionsDelta The hierarchies containing the new members. They may come from several ITransactionCommittedMessage in which case the size of the list is higher than 1. The list is aligned with removalDeltas.

removalDeltas - The hierarchies containing the removed members They may come from several ITransactionCommittedMessage in which case the size of the list is higher than 1. The list is aligned with contributionDeltas.

epoch - The epoch of the remote member corresponding to the commit

viewId - The ID of the view associated with this commit

remoteAddress - The address of the remote instance that have seen the deltas

remotePivotId - The ID of the remote pivot instance that have seen the deltas

properties - The properties

Returns:

The new version after this commit.

Throws:

MergeException - if an exception is encountered during the transaction

onInitialRemoteCommit

IDistributedActivePivotVersion onInitialRemoteCommit(List<? extends IDimension<? extends IHierarchy>> mainDimensions,
                                                     IEpoch epoch,
                                                     long viewId,
                                                     String remoteAddress,
                                                     String applicationId,
                                                     String remotePivotId,
                                                     Properties properties)
                                              throws MergeException

Merges the delta dimensions from a remote instance's initial commit into the underlying IDistributedActivePivot's cube's main dimensions and notifies the listeners.

This creates a new version of this pivot.

Parameters:

mainDimensions - The remote contributions

epoch - The epoch associated with these delta hierarchies on the remote pivot.

viewId - The ID of the view associated with this commit

remoteAddress - address of the remote instance that is responsible for this initial discovery

applicationId - The application to which the remote instance belongs

remotePivotId - the name of the pivot of the remote instance

properties - The properties

Returns:

The new version after this commit.

Throws:

MergeException - if an exception is encountered during the transaction

removeMembersFromCube

IDistributedActivePivotVersion removeMembersFromCube(Set<String> membersToRemove,
                                                     long viewId,
                                                     boolean discard)
                                              throws MergeException

Removes all the contributions from the given cluster members and notifies the listeners.

Parameters:

membersToRemove - The addresses of the members to remove

viewId - The ID of the view associated with this commit

discard - True to remove all contributions from the given remote instances.

Returns:

The new version after this commit.

Throws:

MergeException - if an exception is encountered during the transaction

getDescription

IDistributedActivePivotDescription getDescription()

Gets the IDistributedActivePivotDescription, that is valid for all versions of the distributed pivot.

Specified by:

getDescription in interface IMultiVersionActivePivot

getMessenger

IDistributedMessenger getMessenger()

Returns The messenger used for communicating with the other instances.

getDistributedHierarchyManager

IDistributedHierarchyManager getDistributedHierarchyManager()

Returns the distributedHierarchyManager used to forward the remote transactions to the pivot. It returns null if the cube is not started.

useApplicationMeasureGroups

boolean useApplicationMeasureGroups()

Returns the current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_GROUPS property.

If set to true, distributed measures and hierarchies have the ID of the local pivot they come from as measureGroup.

Returns:

The current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_GROUPS property.

useApplicationMeasureNames

boolean useApplicationMeasureNames()

Returns the current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_NAMES property.

If set to true, measures names have the id of the local pivot they come from as suffix.

Returns:

The current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_NAMES property

useApplicationMeasureGroupsSuffix

boolean useApplicationMeasureGroupsSuffix()

Returns the current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_GROUPS_SUFFIX property.

If set to true, local pivot IDs will be appended to locally defined measure groups.

Returns:

The current value of the IDistributedActivePivotInstanceDescription.APPLICATION_MEASURE_GROUPS_SUFFIX property

getDistributedApplicationInformations

@Deprecated(forRemoval=true,
            since="6.0.1")
@DeprecatedApi(forRemoval="6.1.0",
               rationale="typo")
default Map<String,List<String>> getDistributedApplicationInformations()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getDistributedApplicationInformation() instead

Returns The distributing fields index by their application name.

See Also:

getDistributedApplicationInformation()

getDistributedApplicationInformation

Map<String,List<String>> getDistributedApplicationInformation()

Returns The distributing fields index by their application name.

If an application does not have any distributing field, the associated value is null.

allDiscoveriesApplied

default boolean allDiscoveriesApplied()

Check whether all discoveries have been applied or not.

Notice a discovery is considered as applied if all measures and hierarchies of an application have been received at least once since the QUERY cube has been started. If an application ('myAPP') is disappearing from the cluster after its associated discovery has been applied, the QUERY cube is still considering that this discovery has been applied. That is to say in this case, getDistributedHierarchyManager().isDiscoveryApplied("myAPP") still returns true.

One can use QueryCubeListener to be notify when such changes occur.

Returns:

true if all discoveries have been applied, false otherwise.

getClusterMembersRestAddresses

Map<String,String> getClusterMembersRestAddresses()

Computes the physical addresses of all the data cubes, using their identifiers within the cluster and the properties ActiveViamProperty.DATA_CUBE_REST_ENDPOINT_PORT_PROPERTY, ActiveViamProperty.DATA_CUBE_REST_ENDPOINT_SUFFIX_PROPERTY.

Returns:

A map with the data cube names as keys and their address as values.