com.hazelcast.spi.hotrestart

Class HotRestartIntegrationService

java.lang.Object

com.hazelcast.spi.hotrestart.HotRestartIntegrationService

All Implemented Interfaces:

com.hazelcast.hotrestart.InternalHotRestartService, com.hazelcast.spi.hotrestart.RamStoreRegistry

public class HotRestartIntegrationService
extends Object
implements com.hazelcast.spi.hotrestart.RamStoreRegistry, com.hazelcast.hotrestart.InternalHotRestartService

Provides common services needed for Hot Restart. HotRestartIntegrationService is main integration point between Hot Restart infrastructure and Hazelcast services. It manages RamStoreRegistry(s), is access point for per thread on-heap and off-heap Hot Restart stores. Also, it's listener for membership and cluster state events.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Name of the Hot Restart service.

Constructor Summary

Constructors

Constructor and Description
HotRestartIntegrationService(com.hazelcast.instance.Node node)

Method Summary

Modifier and Type	Method and Description
void	addClusterHotRestartEventListener(ClusterHotRestartEventListener listener)
boolean	backup(long sequence) Creates a snapshot (backup) of the current state of the Hot Restart Store to a directory nested under the configured HotRestartPersistenceConfig.getBackupDir() with the name backup-sequence.
void	ensureHasConfiguration(String serviceName, String name, Object config) Ensures that the configuration exists for the given service name and distributed object name.
void	forceStartBeforeJoin()
File	getBackupDir(long sequence) Returns the member specific backup directory for requested backup sequence
String	getCacheName(long prefix) Returns the distributed object name for the given RamStoreRegistry prefix.
ClusterMetadataManager	getClusterMetadataManager()
com.hazelcast.internal.management.dto.ClusterHotRestartStatusDTO	getCurrentClusterHotRestartStatus()
Set<String>	getExcludedMemberUuids()
File	getHotRestartHome()
com.hazelcast.spi.hotrestart.HotRestartStore	getOffHeapHotRestartStoreForPartition(int partitionId)
com.hazelcast.spi.hotrestart.HotRestartStore	getOnHeapHotRestartStoreForPartition(int partitionId)
void	handleExcludedMemberUuids(com.hazelcast.nio.Address sender, Set<String> excludedMemberUuids)
boolean	isBackupInProgress() Returns true if there is a backup task currently in progress
boolean	isEnabled()
boolean	isMemberExcluded(com.hazelcast.nio.Address memberAddress, String memberUuid)
boolean	isStartCompleted()
void	notifyExcludedMember(com.hazelcast.nio.Address memberAddress)
void	onInitialClusterState(com.hazelcast.cluster.ClusterState initialState)
int	prefixToThreadId(long prefix)
void	prepare() Prepares the Hot restart store for start().
com.hazelcast.spi.hotrestart.RamStore	ramStoreForPrefix(long prefix)
void	registerLoadedConfigurationListener(LoadedConfigurationListener listener)
long	registerRamStore(com.hazelcast.spi.hotrestart.RamStoreRegistry ramStoreRegistry, String serviceName, String name, int partitionId) Registers a RamStoreRegistry.
void	registerRamStoreRegistry(String serviceName, com.hazelcast.spi.hotrestart.RamStoreRegistry registry)
void	resetService(boolean isAfterJoin)
com.hazelcast.spi.hotrestart.RamStore	restartingRamStoreForPrefix(long prefix)
void	shutdown()
void	start() Starts the Hot restart service.
boolean	triggerForceStart()
boolean	triggerPartialStart()
void	waitPartitionReplicaSyncOnCluster(long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Name of the Hot Restart service.

See Also:

Constant Field Values

Constructor Detail

HotRestartIntegrationService

public HotRestartIntegrationService(com.hazelcast.instance.Node node)

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.hazelcast.hotrestart.InternalHotRestartService

registerLoadedConfigurationListener

public void registerLoadedConfigurationListener(LoadedConfigurationListener listener)

ramStoreForPrefix

public com.hazelcast.spi.hotrestart.RamStore ramStoreForPrefix(long prefix)

Specified by:

ramStoreForPrefix in interface com.hazelcast.spi.hotrestart.RamStoreRegistry

restartingRamStoreForPrefix

public com.hazelcast.spi.hotrestart.RamStore restartingRamStoreForPrefix(long prefix)

Specified by:

restartingRamStoreForPrefix in interface com.hazelcast.spi.hotrestart.RamStoreRegistry

prefixToThreadId

public int prefixToThreadId(long prefix)

Specified by:

prefixToThreadId in interface com.hazelcast.spi.hotrestart.RamStoreRegistry

getOnHeapHotRestartStoreForPartition

public com.hazelcast.spi.hotrestart.HotRestartStore getOnHeapHotRestartStoreForPartition(int partitionId)

getOffHeapHotRestartStoreForPartition

public com.hazelcast.spi.hotrestart.HotRestartStore getOffHeapHotRestartStoreForPartition(int partitionId)

registerRamStore

public long registerRamStore(com.hazelcast.spi.hotrestart.RamStoreRegistry ramStoreRegistry,
                             String serviceName,
                             String name,
                             int partitionId)

Registers a RamStoreRegistry. There should already be a configuration for the service and distributed object name. This can be ensured by calling ensureHasConfiguration(String, String, Object).

Parameters:

ramStoreRegistry - the registry to be registered

serviceName - the service name

name - the distributed object name

partitionId - the partition ID

Returns:

the key (prefix) under which the registry is registered in the hot restart service

registerRamStoreRegistry

public void registerRamStoreRegistry(String serviceName,
                                     com.hazelcast.spi.hotrestart.RamStoreRegistry registry)

ensureHasConfiguration

public void ensureHasConfiguration(String serviceName,
                                   String name,
                                   Object config)

Ensures that the configuration exists for the given service name and distributed object name. Creates one if there is none.

Parameters:

serviceName - the service name

name - the distributed object name

config - the configuration

getCacheName

public String getCacheName(long prefix)

Returns the distributed object name for the given RamStoreRegistry prefix.

Parameters:

prefix - the prefix of the RamStoreRegistry

Returns:

the cache name

Throws:

IllegalArgumentException - if there is no descriptor found for this prefix

addClusterHotRestartEventListener

public void addClusterHotRestartEventListener(ClusterHotRestartEventListener listener)

getClusterMetadataManager

public ClusterMetadataManager getClusterMetadataManager()

prepare

public void prepare()

Prepares the Hot restart store for start().

• Checks for any mismatch of number of persisted stores and configured parallelism or persisted and current partition thread count
• Persists the partition thread count if there are no persisted stores
• Prepares the cluster metadata by reading it from disk
• Creates the hot restart off-heap and on-heap stores

start

public void start()

Starts the Hot restart service.

• Starts the metadata manager which validates the cluster metadata loaded from disk
• Restores the cache descriptors from disk
• Loads the hot restart data from disk
• Force starts if not all members joined and force start was requested
• If the target cluster state is not PASSIVE, waits for all members to transition from PASSIVE state

Throws:

HotRestartException - if there was any exception while starting the service

backup

public boolean backup(long sequence)

Creates a snapshot (backup) of the current state of the Hot Restart Store to a directory nested under the configured HotRestartPersistenceConfig.getBackupDir() with the name backup-sequence. The backup will contain all data managed by the Hot Restart service, including persistent cache descriptors, cluster metadata and partition data.

The completeness and consistency of the copied data is guaranteed if the cluster is in the ClusterState.PASSIVE state but can be called in any cluster state. If being called while the cluster is in the ClusterState.ACTIVE state, the user must make certain that no new persistent cache structures are being created or that there are no cluster metadata changes, such as:

• partition table data changes (replica changes)
• cluster state changes
• membership changes (including losing members)

In other cases the snapshot data can be inconsistent. This method will return as soon as it has finished copying cache descriptor data, cluster metadata and started copying partition data. Partition data will be copied asynchronously.

Parameters:

sequence - the backup sequence. This will determine the directory name for the backup

Returns:

if the backup task was run

getBackupDir

public File getBackupDir(long sequence)

Returns the member specific backup directory for requested backup sequence

Parameters:

sequence - backup sequence

Returns:

backup directory

isBackupInProgress

public boolean isBackupInProgress()

Returns true if there is a backup task currently in progress

isStartCompleted

public boolean isStartCompleted()

triggerForceStart

public boolean triggerForceStart()

Specified by:

triggerForceStart in interface com.hazelcast.hotrestart.InternalHotRestartService

triggerPartialStart

public boolean triggerPartialStart()

Specified by:

triggerPartialStart in interface com.hazelcast.hotrestart.InternalHotRestartService

shutdown

public void shutdown()

forceStartBeforeJoin

public void forceStartBeforeJoin()

Specified by:

forceStartBeforeJoin in interface com.hazelcast.hotrestart.InternalHotRestartService

resetService

public void resetService(boolean isAfterJoin)

Specified by:

resetService in interface com.hazelcast.hotrestart.InternalHotRestartService

isMemberExcluded

public boolean isMemberExcluded(com.hazelcast.nio.Address memberAddress,
                                String memberUuid)

Specified by:

isMemberExcluded in interface com.hazelcast.hotrestart.InternalHotRestartService

getExcludedMemberUuids

public Set<String> getExcludedMemberUuids()

Specified by:

getExcludedMemberUuids in interface com.hazelcast.hotrestart.InternalHotRestartService

onInitialClusterState

public void onInitialClusterState(com.hazelcast.cluster.ClusterState initialState)

notifyExcludedMember

public void notifyExcludedMember(com.hazelcast.nio.Address memberAddress)

Specified by:

notifyExcludedMember in interface com.hazelcast.hotrestart.InternalHotRestartService

handleExcludedMemberUuids

public void handleExcludedMemberUuids(com.hazelcast.nio.Address sender,
                                      Set<String> excludedMemberUuids)

Specified by:

handleExcludedMemberUuids in interface com.hazelcast.hotrestart.InternalHotRestartService

getCurrentClusterHotRestartStatus

public com.hazelcast.internal.management.dto.ClusterHotRestartStatusDTO getCurrentClusterHotRestartStatus()

Specified by:

getCurrentClusterHotRestartStatus in interface com.hazelcast.hotrestart.InternalHotRestartService

waitPartitionReplicaSyncOnCluster

public void waitPartitionReplicaSyncOnCluster(long timeout,
                                              TimeUnit unit)

Specified by:

waitPartitionReplicaSyncOnCluster in interface com.hazelcast.hotrestart.InternalHotRestartService

getHotRestartHome

public File getHotRestartHome()