com.hazelcast.instance

Interface NodeExtension

All Known Implementing Classes:

DefaultNodeExtension

@PrivateApi
public interface NodeExtension

NodeExtension is a Node extension mechanism to be able to plug different implementations of some modules, like; SerializationService, SocketChannelWrapperFactory etc.

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> type) 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.
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 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).

Method Detail

beforeStart

void beforeStart()

Called before node is started

printNodeInfo

void printNodeInfo()

Called to print node information during startup

beforeJoin

void beforeJoin()

Called before node attempts to join to the cluster

afterStart

void afterStart()

Called after node is started

isStartCompleted

boolean isStartCompleted()

Returns true if the instance has started

beforeShutdown

void beforeShutdown()

Called before Node.shutdown()

shutdown

void shutdown()

Shutdowns NodeExtension. Called on Node.shutdown()

createSerializationService

InternalSerializationService createSerializationService()

Creates a SerializationService instance to be used by this Node.

Returns:

a SerializationService instance

getSecurityContext

SecurityContext getSecurityContext()

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

Returns:

security context

createService

<T> T createService(Class<T> type)

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

Parameters:

type - type of service

Returns:

service implementation

Throws:

IllegalArgumentException - if type is not known

createExtensionServices

Map<String,Object> createExtensionServices()

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

Returns:

extension services

getMemberSocketInterceptor

MemberSocketInterceptor getMemberSocketInterceptor()

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

Returns:

MemberSocketInterceptor

getSocketChannelWrapperFactory

SocketChannelWrapperFactory getSocketChannelWrapperFactory()

Returns SocketChannelWrapperFactory instance to be used by this Node.

Returns:

SocketChannelWrapperFactory

createReadHandler

ReadHandler createReadHandler(TcpIpConnection connection,
                              IOService ioService)

Creates a ReadHandler for given Connection instance.

Parameters:

connection - tcp-ip connection

ioService - IOService

Returns:

the created ReadHandler.

createWriteHandler

WriteHandler createWriteHandler(TcpIpConnection connection,
                                IOService ioService)

Creates a WriteHandler for given Connection instance.

Parameters:

connection - tcp-ip connection

ioService - IOService

Returns:

the created WriteHandler

onThreadStart

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.

Parameters:

thread - thread starting

onThreadStop

void onThreadStop(Thread thread)

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

Parameters:

thread - thread stopping

getMemoryStats

MemoryStats getMemoryStats()

Returns MemoryStats of for the JVM and current HazelcastInstance.

Returns:

memory statistics

validateJoinRequest

void validateJoinRequest(JoinMessage joinMessage)

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.

onClusterStateChange

void onClusterStateChange(ClusterState newState,
                          boolean isTransient)

Called when cluster state is changed

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

void onPartitionStateChange()

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

onClusterVersionChange

void onClusterVersionChange(ClusterVersion newVersion)

Called after cluster version is changed.

Parameters:

newVersion - the new version at which the cluster operates.

isNodeVersionCompatibleWith

boolean isNodeVersionCompatibleWith(ClusterVersion clusterVersion)

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

Parameters:

clusterVersion - the cluster version to check against

Returns:

true if compatible, otherwise false.

registerListener

boolean registerListener(Object listener)

Registers given listener if it's a known type.

Parameters:

listener - listener instance

Returns:

true if listener is registered, false otherwise

triggerForceStart

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.

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

boolean triggerPartialStart()

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

Returns:

true if partial start is triggered.

getHotRestartBackupService

HotRestartService getHotRestartBackupService()

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

Returns:

the hot restart data backup service

createMemberUuid

String createMemberUuid(Address address)

Creates a UUID for local member

Parameters:

address - address of local member

Returns:

new uuid

isMemberExcluded

boolean isMemberExcluded(Address memberAddress,
                         String memberUuid)

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.

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

Set<String> getExcludedMemberUuids()

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

Returns:

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

handleExcludedMemberUuids

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.

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

ClusterHotRestartStatusDTO getCurrentClusterHotRestartStatus()

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.

resetHotRestartData

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.