org.apache.activemq.artemis.core.server

Class NodeManager

java.lang.Object

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

All Implemented Interfaces:

org.apache.activemq.artemis.core.server.ActiveMQComponent

Direct Known Subclasses:

FileLockNodeManager, InVMNodeManager

public abstract class NodeManager
extends Object
implements org.apache.activemq.artemis.core.server.ActiveMQComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected FileChannel	channel
protected static byte	FIRST_TIME_START
protected boolean	replicatedBackup

Constructor Summary

Constructors

Constructor and Description
NodeManager(boolean replicatedBackup, File directory)

Method Summary

Modifier and Type	Method and Description
abstract void	awaitLiveNode()
abstract void	awaitLiveStatus()
abstract void	crashLiveServer()
protected void	createNodeId()
org.apache.activemq.artemis.api.core.SimpleString	getNodeId()
org.apache.activemq.artemis.utils.UUID	getUUID()
abstract void	interrupt()
abstract boolean	isAwaitingFailback()
abstract boolean	isBackupLive()
boolean	isStarted()
protected File	newFile(String fileName)
abstract void	pauseLiveServer()
abstract org.apache.activemq.artemis.api.core.SimpleString	readNodeId()
abstract void	releaseBackup()
void	setNodeID(String nodeID) Sets the nodeID.
protected void	setUpServerLockFile() Ensures existence of persistent information about the server's nodeID.
protected void	setUUID(org.apache.activemq.artemis.utils.UUID generateUUID)
void	start()
abstract void	startBackup()
abstract ActivateCallback	startLiveNode()
void	stop()
void	stopBackup()

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_TIME_START

protected static final byte FIRST_TIME_START

See Also:

Constant Field Values

replicatedBackup

protected final boolean replicatedBackup

channel

protected FileChannel channel

Constructor Detail

NodeManager

public NodeManager(boolean replicatedBackup,
                   File directory)

Method Detail

awaitLiveNode

public abstract void awaitLiveNode()
                            throws Exception

Throws:

Exception

awaitLiveStatus

public abstract void awaitLiveStatus()
                              throws Exception

Throws:

Exception

startBackup

public abstract void startBackup()
                          throws Exception

Throws:

Exception

startLiveNode

public abstract ActivateCallback startLiveNode()
                                        throws Exception

Throws:

Exception

pauseLiveServer

public abstract void pauseLiveServer()
                              throws Exception

Throws:

Exception

crashLiveServer

public abstract void crashLiveServer()
                              throws Exception

Throws:

Exception

releaseBackup

public abstract void releaseBackup()
                            throws Exception

Throws:

Exception

start

public void start()
           throws Exception

Specified by:

start in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

Throws:

Exception

isStarted

public boolean isStarted()

Specified by:

isStarted in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

getNodeId

public org.apache.activemq.artemis.api.core.SimpleString getNodeId()

readNodeId

public abstract org.apache.activemq.artemis.api.core.SimpleString readNodeId()
                                                                      throws org.apache.activemq.artemis.api.core.ActiveMQIllegalStateException,
                                                                             IOException

Throws:

org.apache.activemq.artemis.api.core.ActiveMQIllegalStateException

IOException

getUUID

public org.apache.activemq.artemis.utils.UUID getUUID()

setNodeID

public void setNodeID(String nodeID)

Sets the nodeID.

Only used by replicating backups.

Parameters:

nodeID -

setUUID

protected void setUUID(org.apache.activemq.artemis.utils.UUID generateUUID)

Parameters:

generateUUID -

isAwaitingFailback

public abstract boolean isAwaitingFailback()
                                    throws Exception

Throws:

Exception

isBackupLive

public abstract boolean isBackupLive()
                              throws Exception

Throws:

Exception

interrupt

public abstract void interrupt()

stop

public void stop()
          throws Exception

Specified by:

stop in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

Throws:

Exception

stopBackup

public final void stopBackup()
                      throws Exception

Throws:

Exception

setUpServerLockFile

protected final void setUpServerLockFile()
                                  throws IOException

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

Roughly the different use cases are:

1. old live server restarts: a server.lock file already exists and contains a nodeID.
2. new live 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)

Returns:

createNodeId

protected final void createNodeId()
                           throws IOException

Throws:

IOException