Package org.apache.activemq.artemis.core.server.impl

Class FileLockNodeManager

java.lang.Object

org.apache.activemq.artemis.core.server.NodeManager

org.apache.activemq.artemis.core.server.impl.FileBasedNodeManager

org.apache.activemq.artemis.core.server.impl.FileLockNodeManager

All Implemented Interfaces:

ActiveMQComponent

public class FileLockNodeManager
extends FileBasedNodeManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FileLockNodeManager.MonitorLock

Nested classes/interfaces inherited from class org.apache.activemq.artemis.core.server.NodeManager

NodeManager.LockListener, NodeManager.NodeManagerException

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	interrupted

Fields inherited from class org.apache.activemq.artemis.core.server.impl.FileBasedNodeManager

activationSequenceChannel, channel, FIRST_TIME_START, SERVER_ACTIVATION_SEQUENCE_NAME, SERVER_LOCK_NAME, serverLockFile

Fields inherited from class org.apache.activemq.artemis.core.server.NodeManager

nodeActivationSequence, nodeIDGuard, NULL_NODE_ACTIVATION_SEQUENCE, replicatedBackup

Constructor Summary

Constructors

Constructor	Description
FileLockNodeManager(File directory, boolean replicatedBackup)
FileLockNodeManager(File directory, boolean replicatedBackup, long lockAcquisitionTimeout, ScheduledExecutorService scheduledPool)
FileLockNodeManager(File directory, boolean replicatedBackup, ScheduledExecutorService scheduledPool)

Method Summary

Modifier and Type	Method	Description
void	awaitActiveStatus()
void	awaitPrimaryNode()
void	crashPrimaryServer()
void	interrupt()
boolean	isAwaitingFailback()
boolean	isBackupActive()
boolean	isPrimaryLocked()
protected FileLock	lock(int lockPosition)
protected void	notifyLostLock()
void	pausePrimaryServer()
final SimpleString	readNodeId()
final void	releaseBackup()
protected void	setUpServerLockFile()	Ensures existence of persistent information about the server's nodeID.
void	start()
void	startBackup()
ActivateCallback	startPrimaryNode()
void	stop()
protected FileLock	tryLock(int lockPos)

Methods inherited from class org.apache.activemq.artemis.core.server.impl.FileBasedNodeManager

createNodeId, newFile, readNodeActivationSequence, stopBackup, writeNodeActivationSequence

Methods inherited from class org.apache.activemq.artemis.core.server.NodeManager

checkStarted, getNodeActivationSequence, getNodeId, getUUID, isStarted, registerLockListener, setNodeActivationSequence, setNodeID, setUUID, unregisterLockListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent

asyncStop

Field Details

interrupted

protected boolean interrupted

Constructor Details

FileLockNodeManager

public FileLockNodeManager(File directory,
 boolean replicatedBackup,
 ScheduledExecutorService scheduledPool)

FileLockNodeManager

public FileLockNodeManager(File directory,
 boolean replicatedBackup)

FileLockNodeManager

public FileLockNodeManager(File directory,
 boolean replicatedBackup,
 long lockAcquisitionTimeout,
 ScheduledExecutorService scheduledPool)

Method Details

start

public void start()
           throws Exception

Specified by:

start in interface ActiveMQComponent

Overrides:

start in class NodeManager

Throws:

Exception

setUpServerLockFile

protected void setUpServerLockFile()
                            throws IOException

Description copied from class: FileBasedNodeManager

Ensures existence of persistent information about the server's nodeID.

Roughly the different use cases are:

1. old server restarts: a server.lock file already exists and contains a nodeID.
2. new server starting for the first time: no file exists, and we just *create* a new UUID to use as nodeID
3. replicated backup received its nodeID from its live: no file exists, we need to persist the *current* nodeID

Overrides:

setUpServerLockFile in class FileBasedNodeManager

Throws:

IOException

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Overrides:

stop in class FileBasedNodeManager

Throws:

Exception

isAwaitingFailback

public boolean isAwaitingFailback()
                           throws NodeManager.NodeManagerException

Specified by:

isAwaitingFailback in class NodeManager

Throws:

NodeManager.NodeManagerException

isBackupActive

public boolean isBackupActive()
                       throws NodeManager.NodeManagerException

Specified by:

isBackupActive in class NodeManager

Throws:

NodeManager.NodeManagerException

isPrimaryLocked

public boolean isPrimaryLocked()

interrupt

public void interrupt()

Specified by:

interrupt in class NodeManager

releaseBackup

public final void releaseBackup()
                         throws NodeManager.NodeManagerException

Specified by:

releaseBackup in class NodeManager

Throws:

NodeManager.NodeManagerException

awaitPrimaryNode

public void awaitPrimaryNode()
                      throws NodeManager.NodeManagerException,
InterruptedException

Specified by:

awaitPrimaryNode in class NodeManager

Throws:

NodeManager.NodeManagerException

InterruptedException

startBackup

public void startBackup()
                 throws NodeManager.NodeManagerException

Specified by:

startBackup in class NodeManager

Throws:

NodeManager.NodeManagerException

startPrimaryNode

public ActivateCallback startPrimaryNode()
                                  throws NodeManager.NodeManagerException

Specified by:

startPrimaryNode in class NodeManager

Throws:

NodeManager.NodeManagerException

pausePrimaryServer

public void pausePrimaryServer()
                        throws NodeManager.NodeManagerException

Specified by:

pausePrimaryServer in class NodeManager

Throws:

NodeManager.NodeManagerException

crashPrimaryServer

public void crashPrimaryServer()
                        throws NodeManager.NodeManagerException

Specified by:

crashPrimaryServer in class NodeManager

Throws:

NodeManager.NodeManagerException

awaitActiveStatus

public void awaitActiveStatus()
                       throws NodeManager.NodeManagerException,
InterruptedException

Specified by:

awaitActiveStatus in class NodeManager

Throws:

NodeManager.NodeManagerException

InterruptedException

readNodeId

public final SimpleString readNodeId()
                              throws NodeManager.NodeManagerException

Specified by:

readNodeId in class NodeManager

Throws:

NodeManager.NodeManagerException

tryLock

protected FileLock tryLock(int lockPos)
                    throws IOException

Throws:

IOException

lock

protected FileLock lock(int lockPosition)
                 throws ActiveMQLockAcquisitionTimeoutException

Throws:

ActiveMQLockAcquisitionTimeoutException

notifyLostLock

protected void notifyLostLock()

Overrides:

notifyLostLock in class NodeManager