com.hazelcast.instance

Class DefaultNodeExtension

java.lang.Object

com.hazelcast.instance.DefaultNodeExtension

All Implemented Interfaces:

NodeExtension

@PrivateApi
public class DefaultNodeExtension
extends Object
implements NodeExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ClusterVersionListener>	clusterVersionListeners
protected ILogger	logger
protected Node	node
protected ILogger	systemLogger

Constructor Summary

Constructors

Constructor and Description
DefaultNodeExtension(Node node)

Method Summary

Modifier and Type	Method and Description
void	afterStart() Called after node is started
void	beforeJoin() Called before node attempts to join to the cluster
void	beforeShutdown() Called before Node.shutdown()
void	beforeStart() Called before node is started
Map<String,Object>	createExtensionServices() Creates additional extension services, which will be registered by service manager during start-up.
String	createMemberUuid(Address address) Creates a UUID for local member
ReadHandler	createReadHandler(TcpIpConnection connection, IOService ioService) Creates a ReadHandler for given Connection instance.
InternalSerializationService	createSerializationService() Creates a SerializationService instance to be used by this Node.
<T> T	createService(Class<T> clazz) Creates a service which is an implementation of given type parameter.
WriteHandler	createWriteHandler(TcpIpConnection connection, IOService ioService) Creates a WriteHandler for given Connection instance.
ClusterHotRestartStatusDTO	getCurrentClusterHotRestartStatus() Returns latest Hot Restart status as Management Center DTO.
Set<String>	getExcludedMemberUuids() Returns uuids of the members that have been excluded during the cluster start.
HotRestartService	getHotRestartBackupService() Returns the hot restart data backup service or null if Hot Restart backup is not available (not EE) or not enabled
MemberSocketInterceptor	getMemberSocketInterceptor() Returns MemberSocketInterceptor for this Node if available, otherwise returns null.
MemoryStats	getMemoryStats() Returns MemoryStats of for the JVM and current HazelcastInstance.
protected PartitioningStrategy	getPartitioningStrategy(ClassLoader configClassLoader)
SecurityContext	getSecurityContext() Returns SecurityContext for this Node if available, otherwise returns null.
SocketChannelWrapperFactory	getSocketChannelWrapperFactory() Returns SocketChannelWrapperFactory instance to be used by this Node.
void	handleExcludedMemberUuids(Address sender, Set<String> excludedMemberUuids) Handles the uuid set of excluded members only if this member is also excluded, and triggers the member force start process.
boolean	isMemberExcluded(Address memberAddress, String memberUuid) Checks if the given member has been excluded during the cluster start or not.
boolean	isNodeVersionCompatibleWith(ClusterVersion clusterVersion) Check if this node's codebase version is compatible with given cluster version.
boolean	isStartCompleted() Returns true if the instance has started
void	onClusterStateChange(ClusterState newState, boolean isTransient) Called when cluster state is changed
void	onClusterVersionChange(ClusterVersion newVersion) Called after cluster version is changed.
void	onPartitionStateChange() Called when partition state (partition assignments, version etc) changes
void	onThreadStart(Thread thread) Called on thread start to inject/intercept extension specific logic, like; registering thread in some service, executing a special method before thread starts to do its own task.
void	onThreadStop(Thread thread) Called before a thread stops to clean/release injected by NodeExtension.onThreadStart(Thread).
void	printNodeInfo() Called to print node information during startup
boolean	registerListener(Object listener) Registers given listener if it's a known type.
void	resetHotRestartData() Resets local hot restart data and gets a new uuid, if the local node hasn't completed the start process and it is excluded in cluster start.
void	shutdown() Shutdowns NodeExtension.
boolean	triggerForceStart() Forces node to start by skipping hot-restart completely and removing all hot-restart data even if node is still on validation phase or loading hot-restart data.
boolean	triggerPartialStart() Triggers partial start if the cluster cannot be started with full recovery and HotRestartPersistenceConfig.clusterDataRecoveryPolicy is set accordingly.
void	validateJoinRequest(JoinMessage joinMessage) Executed on the master node before allowing a new member to join from ClusterJoinManager.handleJoinRequest(JoinRequest, Connection).

Methods inherited from class java.lang.Object

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

Field Detail

node

protected final Node node

logger

protected final ILogger logger

systemLogger

protected final ILogger systemLogger

clusterVersionListeners

protected final List<ClusterVersionListener> clusterVersionListeners

Constructor Detail

DefaultNodeExtension

public DefaultNodeExtension(Node node)

Method Detail

beforeStart

public void beforeStart()

Description copied from interface: NodeExtension

Called before node is started

Specified by:

beforeStart in interface NodeExtension

printNodeInfo

public void printNodeInfo()

Description copied from interface: NodeExtension

Called to print node information during startup

Specified by:

printNodeInfo in interface NodeExtension

beforeJoin

public void beforeJoin()

Description copied from interface: NodeExtension

Called before node attempts to join to the cluster

Specified by:

beforeJoin in interface NodeExtension

afterStart

public void afterStart()

Description copied from interface: NodeExtension

Called after node is started

Specified by:

afterStart in interface NodeExtension

isStartCompleted

public boolean isStartCompleted()

Description copied from interface: NodeExtension

Returns true if the instance has started

Specified by:

isStartCompleted in interface NodeExtension

getSecurityContext

public SecurityContext getSecurityContext()

Description copied from interface: NodeExtension

Returns SecurityContext for this Node if available, otherwise returns null.

Specified by:

getSecurityContext in interface NodeExtension

Returns:

security context

createSerializationService

public InternalSerializationService createSerializationService()

Description copied from interface: NodeExtension

Creates a SerializationService instance to be used by this Node.

Specified by:

createSerializationService in interface NodeExtension

Returns:

a SerializationService instance

getPartitioningStrategy

protected PartitioningStrategy getPartitioningStrategy(ClassLoader configClassLoader)
                                                throws Exception

Throws:

Exception

createService

public <T> T createService(Class<T> clazz)

Description copied from interface: NodeExtension

Creates a service which is an implementation of given type parameter.

Specified by:

createService in interface NodeExtension

Parameters:

clazz - type of service

Returns:

service implementation

createExtensionServices

public Map<String,Object> createExtensionServices()

Description copied from interface: NodeExtension

Creates additional extension services, which will be registered by service manager during start-up. By default returned map will be empty.

Specified by:

createExtensionServices in interface NodeExtension

Returns:

extension services

getMemberSocketInterceptor

public MemberSocketInterceptor getMemberSocketInterceptor()

Description copied from interface: NodeExtension

Returns MemberSocketInterceptor for this Node if available, otherwise returns null.

Specified by:

getMemberSocketInterceptor in interface NodeExtension

Returns:

MemberSocketInterceptor

getSocketChannelWrapperFactory

public SocketChannelWrapperFactory getSocketChannelWrapperFactory()

Description copied from interface: NodeExtension

Returns SocketChannelWrapperFactory instance to be used by this Node.

Specified by:

getSocketChannelWrapperFactory in interface NodeExtension

Returns:

SocketChannelWrapperFactory

createReadHandler

public ReadHandler createReadHandler(TcpIpConnection connection,
                                     IOService ioService)

Description copied from interface: NodeExtension

Creates a ReadHandler for given Connection instance.

Specified by:

createReadHandler in interface NodeExtension

Parameters:

connection - tcp-ip connection

ioService - IOService

Returns:

the created ReadHandler.

createWriteHandler

public WriteHandler createWriteHandler(TcpIpConnection connection,
                                       IOService ioService)

Description copied from interface: NodeExtension

Creates a WriteHandler for given Connection instance.

Specified by:

createWriteHandler in interface NodeExtension

Parameters:

connection - tcp-ip connection

ioService - IOService

Returns:

the created WriteHandler

onThreadStart

public void onThreadStart(Thread thread)

Description copied from interface: NodeExtension

Called on thread start to inject/intercept extension specific logic, like; registering thread in some service, executing a special method before thread starts to do its own task.

Specified by:

onThreadStart in interface NodeExtension

Parameters:

thread - thread starting

onThreadStop

public void onThreadStop(Thread thread)

Description copied from interface: NodeExtension

Called before a thread stops to clean/release injected by NodeExtension.onThreadStart(Thread).

Specified by:

onThreadStop in interface NodeExtension

Parameters:

thread - thread stopping

getMemoryStats

public MemoryStats getMemoryStats()

Description copied from interface: NodeExtension

Returns MemoryStats of for the JVM and current HazelcastInstance.

Specified by:

getMemoryStats in interface NodeExtension

Returns:

memory statistics

beforeShutdown

public void beforeShutdown()

Description copied from interface: NodeExtension

Called before Node.shutdown()

Specified by:

beforeShutdown in interface NodeExtension

shutdown

public void shutdown()

Description copied from interface: NodeExtension

Shutdowns NodeExtension. Called on Node.shutdown()

Specified by:

shutdown in interface NodeExtension

validateJoinRequest

public void validateJoinRequest(JoinMessage joinMessage)

Description copied from interface: NodeExtension

Executed on the master node before allowing a new member to join from ClusterJoinManager.handleJoinRequest(JoinRequest, Connection). Implementation should check if the JoinMessage should be allowed to proceed, otherwise throw an exception with a message explaining rejection reason.

Specified by:

validateJoinRequest in interface NodeExtension

onClusterStateChange

public void onClusterStateChange(ClusterState newState,
                                 boolean isTransient)

Description copied from interface: NodeExtension

Called when cluster state is changed

Specified by:

onClusterStateChange in interface NodeExtension

Parameters:

newState - new state

isTransient - status of the change. A cluster state change may be transient if it has been done temporarily during system operations such cluster start etc.

onPartitionStateChange

public void onPartitionStateChange()

Description copied from interface: NodeExtension

Called when partition state (partition assignments, version etc) changes

Specified by:

onPartitionStateChange in interface NodeExtension

onClusterVersionChange

public void onClusterVersionChange(ClusterVersion newVersion)

Description copied from interface: NodeExtension

Called after cluster version is changed.

Specified by:

onClusterVersionChange in interface NodeExtension

Parameters:

newVersion - the new version at which the cluster operates.

isNodeVersionCompatibleWith

public boolean isNodeVersionCompatibleWith(ClusterVersion clusterVersion)

Description copied from interface: NodeExtension

Check if this node's codebase version is compatible with given cluster version.

Specified by:

isNodeVersionCompatibleWith in interface NodeExtension

Parameters:

clusterVersion - the cluster version to check against

Returns:

true if compatible, otherwise false.

registerListener

public boolean registerListener(Object listener)

Description copied from interface: NodeExtension

Registers given listener if it's a known type.

Specified by:

registerListener in interface NodeExtension

Parameters:

listener - listener instance

Returns:

true if listener is registered, false otherwise

triggerForceStart

public boolean triggerForceStart()

Description copied from interface: NodeExtension

Forces node to start by skipping hot-restart completely and removing all hot-restart data even if node is still on validation phase or loading hot-restart data.

Specified by:

triggerForceStart in interface NodeExtension

Returns:

true if force start is triggered successfully. force start cannot be triggered if hot restart is disabled or the master is not known yet

triggerPartialStart

public boolean triggerPartialStart()

Description copied from interface: NodeExtension

Triggers partial start if the cluster cannot be started with full recovery and HotRestartPersistenceConfig.clusterDataRecoveryPolicy is set accordingly.

Specified by:

triggerPartialStart in interface NodeExtension

Returns:

true if partial start is triggered.

getHotRestartBackupService

public HotRestartService getHotRestartBackupService()

Description copied from interface: NodeExtension

Returns the hot restart data backup service or null if Hot Restart backup is not available (not EE) or not enabled

Specified by:

getHotRestartBackupService in interface NodeExtension

Returns:

the hot restart data backup service

createMemberUuid

public String createMemberUuid(Address address)

Description copied from interface: NodeExtension

Creates a UUID for local member

Specified by:

createMemberUuid in interface NodeExtension

Parameters:

address - address of local member

Returns:

new uuid

isMemberExcluded

public boolean isMemberExcluded(Address memberAddress,
                                String memberUuid)

Description copied from interface: NodeExtension

Checks if the given member has been excluded during the cluster start or not. If returns true, it means that the given member is not allowed to join to the cluster.

Specified by:

isMemberExcluded in interface NodeExtension

Parameters:

memberAddress - address of the member to check

memberUuid - uuid of the member to check

Returns:

true if the member has been excluded on cluster start.

getExcludedMemberUuids

public Set<String> getExcludedMemberUuids()

Description copied from interface: NodeExtension

Returns uuids of the members that have been excluded during the cluster start.

Specified by:

getExcludedMemberUuids in interface NodeExtension

Returns:

uuids of the members that have been excluded during the cluster start

handleExcludedMemberUuids

public void handleExcludedMemberUuids(Address sender,
                                      Set<String> excludedMemberUuids)

Description copied from interface: NodeExtension

Handles the uuid set of excluded members only if this member is also excluded, and triggers the member force start process.

Specified by:

handleExcludedMemberUuids in interface NodeExtension

Parameters:

sender - the member that has sent the excluded members set

excludedMemberUuids - uuids of the members that have been excluded during the cluster start

getCurrentClusterHotRestartStatus

public ClusterHotRestartStatusDTO getCurrentClusterHotRestartStatus()

Description copied from interface: NodeExtension

Returns latest Hot Restart status as Management Center DTO. An empty status object will be returned if Hot Restart is not available (not EE) or not enabled.

Specified by:

getCurrentClusterHotRestartStatus in interface NodeExtension

resetHotRestartData

public void resetHotRestartData()

Description copied from interface: NodeExtension

Resets local hot restart data and gets a new uuid, if the local node hasn't completed the start process and it is excluded in cluster start.

Specified by:

resetHotRestartData in interface NodeExtension