com.mulesoft.mule.runtime.module.cluster.api

Interface ClusterCoreExtension

All Superinterfaces:

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

All Known Implementing Classes:

HazelcastClusterCoreExtension

@NoImplement
public interface ClusterCoreExtension
extends org.mule.runtime.container.api.MuleCoreExtension, org.mule.runtime.module.deployment.api.ArtifactDeploymentListener

Implementations provides access to controlling clustering in the Mule Instance.

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

Since:

4.0

Field Summary

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

Method Summary

Modifier and Type	Method and Description
ClusteringTicket	getClusteringTicket() Alows server plugins to query the clustering properties.
ClusterMemberInfo	getClusterMemberInfo()
boolean	isClusterEnabled()
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 listener) 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.
boolean	unregisterClusterMembershipListener(String listenerRegistrationId) Removes the specified MembershipListener.

Methods inherited from interface org.mule.runtime.container.api.MuleCoreExtension

setContainerClassLoader

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

initialise

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

start

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

stop

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

dispose

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

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

onArtifactCreated, onArtifactInitialised, onDeploymentFailure, onDeploymentStart, onDeploymentSuccess, onUndeploymentFailure, onUndeploymentStart, onUndeploymentSuccess

Method Detail

registerPrimaryNodeListener

void registerPrimaryNodeListener(PrimaryClusterNodeListener listener)

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

Parameters:

listener - primary node listener to be registered

registerClusterMembershipListener

String registerClusterMembershipListener(ClusterMembershipListener listener)

Adds MembershipListener to listen for membership updates.

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

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

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

Parameters:

listener - membership listener

Returns:

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

Throws:

NullPointerException - if listener is null.

See Also:

unregisterClusterMembershipListener(String)

unregisterClusterMembershipListener

boolean unregisterClusterMembershipListener(String listenerRegistrationId)

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.

Parameters:

registrationId - the registrationId of MembershipListener to remove.

Returns:

true if the registration is removed, false otherwise.

Throws:

NullPointerException - if the registration ID is null.

See Also:

registerClusterMembershipListener(ClusterMembershipListener)

getClusteringTicket

ClusteringTicket getClusteringTicket()
                              throws org.mule.runtime.api.exception.MuleRuntimeException

Alows server plugins to query the clustering properties.

Returns:

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

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - wrapping any excpetion that happens internally.

putClusteringTicket

void putClusteringTicket(ClusteringTicket ticket)
                  throws org.mule.runtime.api.exception.MuleRuntimeException

Alows server plugins to specify the clustering properties.

Parameters:

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

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - wrapping any excpetion that happens internally.

isClusterEnabled

boolean isClusterEnabled()

Returns:

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

removeClusteringTicket

void removeClusteringTicket()
                     throws org.mule.runtime.api.exception.MuleRuntimeException

Alows server plugins to clear the clustering properties.

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - wrapping any excpetion that happens internally.

getClusterMemberInfo

ClusterMemberInfo getClusterMemberInfo()

Returns:

information about the local node of the cluster.