com.sequoiadb.base

类 ReplicaGroup

java.lang.Object

com.sequoiadb.base.ReplicaGroup

public class ReplicaGroup
extends Object

Replica group of SequoiaDB.

方法概要

限定符和类型	方法和说明
Node	attachNode(String hostName, int port, BSONObject configure) Attach node.
Node	createNode(String hostName, int port, String dbPath) Create node.
Node	createNode(String hostName, int port, String dbPath, BSONObject configure) Create node.
void	detachNode(String hostName, int port, BSONObject configure) Detach node.
BSONObject	getDetail() Get detail info of current replicaGroup
String	getGroupName()
int	getId()
Node	getMaster() Get the master node of current replica group.
Node	getNode(String nodeName) Get node by node's name (IP:PORT).
Node	getNode(String hostName, int port) Get node by hostName and port.
Sequoiadb	getSequoiadb()
Node	getSlave() Get the random slave node of current replica group, when have no slave node, return master node.
Node	getSlave(Collection<Integer> positions) Get the slave node in the specified positions, when have no slave node in the specified positions, return master node.
Node	getSlave(int... positions) Get the slave node in the specified positions, when have no slave node in the specified positions, return master node.
boolean	isCatalog() Judge whether current replicaGroup is catalog replica group or not.
boolean	isNodeExist(String nodeName) whether the specified node exists in current group or not
boolean	isNodeExist(String hostName, int port) whether the specified node exists in current group or not
void	removeNode(String hostName, int port, BSONObject configure) Remove node.
void	start() Start current replica group.
void	stop() Stop current replica group.

从类继承的方法 java.lang.Object

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

方法详细资料

attachNode

public Node attachNode(String hostName,
                       int port,
                       BSONObject configure)
                throws BaseException

Attach node.

参数:

hostName - host name

port - port

configure - configuration for this operation

返回:

the attach Node object

抛出:

BaseException - If error happens.

createNode

public Node createNode(String hostName,
                       int port,
                       String dbPath)
                throws BaseException

Create node.

参数:

hostName - host name

port - port

dbPath - the path for node

返回:

the created Node object

抛出:

BaseException - If error happens.

createNode

public Node createNode(String hostName,
                       int port,
                       String dbPath,
                       BSONObject configure)
                throws BaseException

Create node.

参数:

hostName - host name

port - port

dbPath - the path for node

configure - configuration for this operation

返回:

the created Node object

抛出:

BaseException - If error happens.

detachNode

public void detachNode(String hostName,
                       int port,
                       BSONObject configure)
                throws BaseException

Detach node.

参数:

hostName - host name

port - port

configure - configuration for this operation

抛出:

BaseException - If error happens.

getDetail

public BSONObject getDetail()
                     throws BaseException

Get detail info of current replicaGroup

返回:

the detail info

抛出:

BaseException - If error happens.

getGroupName

public String getGroupName()

返回:

the current replica group's name

getId

public int getId()

返回:

the current replica group's id

getMaster

public Node getMaster()
               throws BaseException

Get the master node of current replica group.

返回:

the master node

抛出:

BaseException - If error happens.

getNode

public Node getNode(String nodeName)
             throws BaseException

Get node by node's name (IP:PORT).

参数:

nodeName - The name of the node

返回:

the specified node

抛出:

BaseException

getNode

public Node getNode(String hostName,
                    int port)
             throws BaseException

Get node by hostName and port.

参数:

hostName - host name

port - port

返回:

the Node object

抛出:

BaseException

getSequoiadb

public Sequoiadb getSequoiadb()

返回:

the current replica group's Sequoiadb

getSlave

public Node getSlave()
              throws BaseException

Get the random slave node of current replica group, when have no slave node, return master node.

返回:

the slave node

抛出:

BaseException - If error happens.

getSlave

public Node getSlave(Collection<Integer> positions)
              throws BaseException

Get the slave node in the specified positions, when have no slave node in the specified positions, return master node.

参数:

positions - the collection of nodes' positions. The position of a node is depended on the index of the node defined in catalog. But the beginning position of a node is start from 1 instead of 0, so it can be 1-7.

返回:

the slave node

抛出:

BaseException

getSlave

public Node getSlave(int... positions)
              throws BaseException

Get the slave node in the specified positions, when have no slave node in the specified positions, return master node.

参数:

positions - The positions of nodes. The position of a node is depended on the index of the node defined in catalog. But the beginning position of a node is start from 1 instead of 0, so it can be 1-7.

返回:

the slave node

抛出:

BaseException - If error happens.

isCatalog

public boolean isCatalog()

Judge whether current replicaGroup is catalog replica group or not.

返回:

true is while false is not

isNodeExist

public boolean isNodeExist(String nodeName)

whether the specified node exists in current group or not

参数:

nodeName - the name of the node. e.g. "192.168.20.165:20000"

返回:

true or false

isNodeExist

public boolean isNodeExist(String hostName,
                           int port)

whether the specified node exists in current group or not

参数:

hostName -

port -

返回:

true or false

removeNode

public void removeNode(String hostName,
                       int port,
                       BSONObject configure)
                throws BaseException

Remove node.

参数:

hostName - host name

port - port

configure - configuration for this operation

抛出:

BaseException - If error happens.

start

public void start()
           throws BaseException

Start current replica group.

抛出:

BaseException - If error happens.

stop

public void stop()
          throws BaseException

Stop current replica group.

抛出:

BaseException - If error happens.