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

Class FileBasedNodeManager

java.lang.Object

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

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

All Implemented Interfaces:

ActiveMQComponent

Direct Known Subclasses:

FileLockNodeManager, InVMNodeManager

public abstract class FileBasedNodeManager
extends NodeManager

Nested Class Summary

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 FileChannel	activationSequenceChannel
protected FileChannel	channel
protected static final byte	FIRST_TIME_START
static final String	SERVER_ACTIVATION_SEQUENCE_NAME
static final String	SERVER_LOCK_NAME
protected File	serverLockFile

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

nodeActivationSequence, nodeIDGuard, NULL_NODE_ACTIVATION_SEQUENCE, replicatedBackup

Constructor Summary

Constructors

Constructor	Description
FileBasedNodeManager(boolean replicatedBackup, File directory)

Method Summary

Modifier and Type	Method	Description
protected final void	createNodeId()
protected final File	newFile(String fileName)
long	readNodeActivationSequence()
protected void	setUpServerLockFile()	Ensures existence of persistent information about the server's nodeID.
void	stop()
void	stopBackup()
void	writeNodeActivationSequence(long sequence)

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

awaitActiveStatus, awaitPrimaryNode, checkStarted, crashPrimaryServer, getNodeActivationSequence, getNodeId, getUUID, interrupt, isAwaitingFailback, isBackupActive, isStarted, notifyLostLock, pausePrimaryServer, readNodeId, registerLockListener, releaseBackup, setNodeActivationSequence, setNodeID, setUUID, start, startBackup, startPrimaryNode, 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

FIRST_TIME_START

protected static final byte FIRST_TIME_START

See Also:

• Constant Field Values

SERVER_LOCK_NAME

public static final String SERVER_LOCK_NAME

See Also:

• Constant Field Values

SERVER_ACTIVATION_SEQUENCE_NAME

public static final String SERVER_ACTIVATION_SEQUENCE_NAME

See Also:

• Constant Field Values

serverLockFile

protected File serverLockFile

channel

protected FileChannel channel

activationSequenceChannel

protected FileChannel activationSequenceChannel

Constructor Details

FileBasedNodeManager

public FileBasedNodeManager(boolean replicatedBackup,
 File directory)

Method Details

readNodeActivationSequence

public long readNodeActivationSequence()
                                throws NodeManager.NodeManagerException

Overrides:

readNodeActivationSequence in class NodeManager

Throws:

NodeManager.NodeManagerException

writeNodeActivationSequence

public void writeNodeActivationSequence(long sequence)
                                 throws NodeManager.NodeManagerException

Overrides:

writeNodeActivationSequence in class NodeManager

Throws:

NodeManager.NodeManagerException

setUpServerLockFile

protected void setUpServerLockFile()
                            throws IOException

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

Throws:

IOException

newFile

protected final File newFile(String fileName)

createNodeId

protected final void createNodeId()
                           throws IOException

Throws:

IOException

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Overrides:

stop in class NodeManager

Throws:

Exception

stopBackup

public void stopBackup()
                throws NodeManager.NodeManagerException

Overrides:

stopBackup in class NodeManager

Throws:

NodeManager.NodeManagerException