com.mulesoft.mule.runtime.module.cluster.internal

Class HazelcastClusterCoreExtension

java.lang.Object

com.mulesoft.mule.runtime.module.cluster.internal.HazelcastClusterCoreExtension

All Implemented Interfaces:

ClusterCoreExtension, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.NamedObject, org.mule.runtime.container.api.MuleCoreExtension, org.mule.runtime.module.deployment.api.ArtifactDeploymentListener

public class HazelcastClusterCoreExtension
extends Object
implements ClusterCoreExtension

Provides access to controlling clustering in the Mule Instance

Field Summary

Fields

Modifier and Type	Field and Description
protected HazelcastClusterManager	hazelcastManager

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
HazelcastClusterCoreExtension()
HazelcastClusterCoreExtension(org.mule.runtime.module.artifact.api.classloader.ClassLoaderRepository classLoaderRepository)

Method Summary

Modifier and Type	Method and Description
protected HazelcastClusterManager	createHazelcastManager()
void	dispose()
ClusteringTicket	getClusteringTicket() Alows server plugins to query the clustering properties.
ClusterMemberInfo	getClusterMemberInfo()
ClusterMemberInfo	getClusterMemberInfo(boolean primaryPollingInstance, com.hazelcast.core.Member clusterLocalMember)
String	getCurrentClusterId()
HazelcastClusterManager	getHazelcastManager()
String	getName()
static File	getTicketFile()
void	initialise()
boolean	isClusterEnabled()
static boolean	isClusteringEnabled()
boolean	isClusteringLicensed()
void	onArtifactCreated(org.mule.runtime.core.api.config.bootstrap.ArtifactType type, String appName, org.mule.runtime.api.config.custom.CustomizationService customizationService)
void	onArtifactInitialised(org.mule.runtime.core.api.config.bootstrap.ArtifactType type, String artifactName, org.mule.runtime.api.artifact.Registry registry)
void	onUndeploymentSuccess(org.mule.runtime.core.api.config.bootstrap.ArtifactType type, String artifactName)
void	putClusteringTicket(ClusteringTicket ticket) Alows server plugins to specify the clustering properties.
String	registerClusterMembershipListener(ClusterMembershipListener listener) Adds MembershipListener to listen for membership updates.
void	registerPrimaryNodeListener(PrimaryClusterNodeListener primaryClusterNodeListener) Register a listener to be notified when the runtime becomes the primary node in the cluster.
void	removeClusteringTicket() Alows server plugins to clear the clustering properties.
void	setContainerClassLoader(org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader containerClassLoader)
void	start()
void	stop()
boolean	unregisterClusterMembershipListener(String listenerRegistrationId) Removes the specified MembershipListener.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.module.deployment.api.ArtifactDeploymentListener

onDeploymentFailure, onDeploymentStart, onDeploymentSuccess, onUndeploymentFailure, onUndeploymentStart

Field Detail

hazelcastManager

protected HazelcastClusterManager hazelcastManager

Constructor Detail

HazelcastClusterCoreExtension

public HazelcastClusterCoreExtension()

HazelcastClusterCoreExtension

public HazelcastClusterCoreExtension(org.mule.runtime.module.artifact.api.classloader.ClassLoaderRepository classLoaderRepository)

Method Detail

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

createHazelcastManager

protected HazelcastClusterManager createHazelcastManager()
                                                  throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

getClusteringTicket

public ClusteringTicket getClusteringTicket()

Description copied from interface: ClusterCoreExtension

Alows server plugins to query the clustering properties.

Specified by:

getClusteringTicket in interface ClusterCoreExtension

Returns:

a ticket object that specifies the properties of Mule instances clustering.

isClusteringLicensed

public boolean isClusteringLicensed()

putClusteringTicket

public void putClusteringTicket(ClusteringTicket ticket)

Description copied from interface: ClusterCoreExtension

Alows server plugins to specify the clustering properties.

Specified by:

putClusteringTicket in interface ClusterCoreExtension

Parameters:

ticket - a ticket object that specifies the properties of Mule instances clustering.

isClusterEnabled

public boolean isClusterEnabled()

Specified by:

isClusterEnabled in interface ClusterCoreExtension

Returns:

true if the runtime is running in cluster mode, false otherwise.

removeClusteringTicket

public void removeClusteringTicket()

Description copied from interface: ClusterCoreExtension

Alows server plugins to clear the clustering properties.

Specified by:

removeClusteringTicket in interface ClusterCoreExtension

getCurrentClusterId

public String getCurrentClusterId()

getTicketFile

public static File getTicketFile()
                          throws IOException

Throws:

IOException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

isClusteringEnabled

public static boolean isClusteringEnabled()
                                   throws Exception

Throws:

Exception

onArtifactCreated

public void onArtifactCreated(org.mule.runtime.core.api.config.bootstrap.ArtifactType type,
                              String appName,
                              org.mule.runtime.api.config.custom.CustomizationService customizationService)

Specified by:

onArtifactCreated in interface org.mule.runtime.module.deployment.api.ArtifactDeploymentListener

onArtifactInitialised

public void onArtifactInitialised(org.mule.runtime.core.api.config.bootstrap.ArtifactType type,
                                  String artifactName,
                                  org.mule.runtime.api.artifact.Registry registry)

Specified by:

onArtifactInitialised in interface org.mule.runtime.module.deployment.api.ArtifactDeploymentListener

onUndeploymentSuccess

public void onUndeploymentSuccess(org.mule.runtime.core.api.config.bootstrap.ArtifactType type,
                                  String artifactName)

Specified by:

onUndeploymentSuccess in interface org.mule.runtime.module.deployment.api.ArtifactDeploymentListener

getHazelcastManager

public HazelcastClusterManager getHazelcastManager()

registerPrimaryNodeListener

public void registerPrimaryNodeListener(PrimaryClusterNodeListener primaryClusterNodeListener)

Description copied from interface: ClusterCoreExtension

Register a listener to be notified when the runtime becomes the primary node in the cluster.

Specified by:

registerPrimaryNodeListener in interface ClusterCoreExtension

Parameters:

primaryClusterNodeListener - primary node listener to be registered

registerClusterMembershipListener

public String registerClusterMembershipListener(ClusterMembershipListener listener)

Description copied from interface: ClusterCoreExtension

Adds MembershipListener to listen for membership updates.

The addMembershipListener method returns a register-id. This ID is needed to remove the MembershipListener using the ClusterCoreExtension.unregisterClusterMembershipListener(String) method.

There is no check for duplicate registrations, so if you register the listener twice, it will get events twice.

If ClusterCoreExtension.isClusterEnabled() is false, then the listener will not be invoke and any call to this method will be disregard.

Specified by:

registerClusterMembershipListener in interface ClusterCoreExtension

Parameters:

listener - membership listener

Returns:

the registration ID. Null if the the runtime is not in cluster mode.

See Also:

ClusterCoreExtension.unregisterClusterMembershipListener(String)

unregisterClusterMembershipListener

public boolean unregisterClusterMembershipListener(String listenerRegistrationId)

Description copied from interface: ClusterCoreExtension

Removes the specified MembershipListener.

If the same MembershipListener is registered multiple times, it needs to be removed multiple times. This method can safely be called multiple times for the same registration-id; subsequent calls are ignored.

Specified by:

unregisterClusterMembershipListener in interface ClusterCoreExtension

Returns:

true if the registration is removed, false otherwise.

See Also:

ClusterCoreExtension.registerClusterMembershipListener(ClusterMembershipListener)

getClusterMemberInfo

public ClusterMemberInfo getClusterMemberInfo()

Specified by:

getClusterMemberInfo in interface ClusterCoreExtension

Returns:

information about the local node of the cluster.

getClusterMemberInfo

public ClusterMemberInfo getClusterMemberInfo(boolean primaryPollingInstance,
                                              com.hazelcast.core.Member clusterLocalMember)

setContainerClassLoader

public void setContainerClassLoader(org.mule.runtime.module.artifact.api.classloader.ArtifactClassLoader containerClassLoader)

Specified by:

setContainerClassLoader in interface org.mule.runtime.container.api.MuleCoreExtension