Index (Broker - Coordination 4.0.41 API)

A B C D G H I L M N O P R S T U

A

AbstractHaStrategy - Class in org.wso2.broker.coordination: Abstract class representing default implementations of HA strategy.
AbstractHaStrategy() - Constructor for class org.wso2.broker.coordination.AbstractHaStrategy
activate() - Method in class org.wso2.broker.coordination.BasicHaListener: Default implementation of method to be invoked once the node state changes to active.
activate() - Method in interface org.wso2.broker.coordination.HaListener: Method to be invoked once the node state changes to active.
addCoordinationListener(RdbmsCoordinationListener) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Method to set listeners expecting notifications regarding changes in the coordinator.
ANCHOR - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants

B

BasicHaListener - Class in org.wso2.broker.coordination: Representation of a listener listening on node state changes defining basic functionality on node state change.
BasicHaListener(HaListener) - Constructor for class org.wso2.broker.coordination.BasicHaListener
becameCoordinatorNode() - Method in interface org.wso2.broker.coordination.rdbms.RdbmsCoordinationListener: Method to be invoked once the node becomes the coordinator node.
becameCoordinatorNode() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy: Method to be invoked once the node becomes the coordinator node.
BrokerHaConfiguration - Class in org.wso2.broker.coordination: Configuration for HA.
BrokerHaConfiguration() - Constructor for class org.wso2.broker.coordination.BrokerHaConfiguration

C

checkIfCoordinatorValid(int) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Check if the coordinator is invalid using the heart beat value.
checkIsCoordinator(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Check if the given node is the coordinator.
close(ResultSet, String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Close the result set resource.
close(PreparedStatement, String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Close the prepared statement resource.
close(Connection, String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Closes the provided connection, on failure logs the error.
CLUSTER_COORDINATOR_HEARTBEAT_TABLE - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
CLUSTER_NODE_HEARTBEAT_TABLE - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
CoordinationException - Exception in org.wso2.broker.coordination: Represents an exception of the broker occurring during coordination.
CoordinationException(String) - Constructor for exception org.wso2.broker.coordination.CoordinationException
CoordinationException(String, Throwable) - Constructor for exception org.wso2.broker.coordination.CoordinationException
CoordinationStrategy - Interface in org.wso2.broker.coordination: The interface representing the coordination algorithm used to elect/identify the coordinator in the cluster.
COORDINATOR_ANCHOR - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
COORDINATOR_ENTRY_CREATION_WAIT_TIME - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
createCoordinatorEntry(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Method to create coordinator entry (i.e - make this node the coordinator).
createNodeHeartbeatEntry(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Method to create the node heartbeat entry.

D

deactivate() - Method in class org.wso2.broker.coordination.BasicHaListener: Default implementation of method to be invoked once the node state changes to passive.
deactivate() - Method in interface org.wso2.broker.coordination.HaListener: Method to be invoked once the node state changes to passive.

G

getAllHeartBeatData() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Get node heart beat status for all the existing nodes.
getAllNodeDetails() - Method in interface org.wso2.broker.coordination.CoordinationStrategy: Retrieve node details of all the nodes.
getAllNodeDetails() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Retrieve node details of all the nodes.
getAllNodeIdentifiers() - Method in interface org.wso2.broker.coordination.CoordinationStrategy: Retrieve IDs of all the nodes.
getAllNodeIdentifiers() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Retrieve IDs of all the nodes.
getConnection() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Create a connection using a thread pooled data source object and return the connection.
getCoordinatorNodeId() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Retrieve the current coordinator's node ID.
getHaStrategy(StartupContext) - Static method in class org.wso2.broker.coordination.HaStrategyFactory: Method to retrieve an instance of the specified implementation of HaStrategy.
getLastHeartbeat() - Method in class org.wso2.broker.coordination.node.NodeHeartbeatData: Getter method for last heartbeat.
getNodeId() - Method in class org.wso2.broker.coordination.node.NodeDetail: Getter method for the node ID.
getNodeId() - Method in class org.wso2.broker.coordination.node.NodeHeartbeatData: Getter method for Node ID.
getNodeIdentifierOfCoordinator() - Method in interface org.wso2.broker.coordination.CoordinationStrategy: Retrieve the node ID of the coordinator node.
getNodeIdentifierOfCoordinator() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Retrieve the node ID of the coordinator node.
getOptions() - Method in class org.wso2.broker.coordination.BrokerHaConfiguration
getStrategy() - Method in class org.wso2.broker.coordination.BrokerHaConfiguration

H

HaListener - Interface in org.wso2.broker.coordination: Representation of a listener listening on node state changes.
HaStrategy - Interface in org.wso2.broker.coordination: Representation of the HA strategy.
HaStrategyFactory - Class in org.wso2.broker.coordination: Factory class to retrieve an instance of the specified implementation of HaStrategy.
HaStrategyFactory() - Constructor for class org.wso2.broker.coordination.HaStrategyFactory
HEARTBEAT_INTERVAL - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants

I

IS_NEW_NODE - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
isActive() - Method in class org.wso2.broker.coordination.BasicHaListener: Method to retrieve if the listener registered corresponds to the active node.
isActiveNode() - Method in interface org.wso2.broker.coordination.HaStrategy: Method to identify if the local node is the active node.
isActiveNode() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy: Method to identify if the local node is the active node.
isCoordinator() - Method in interface org.wso2.broker.coordination.CoordinationStrategy: Used to query if the current node is the coordinator.
isCoordinator() - Method in class org.wso2.broker.coordination.node.NodeDetail: Retrieve whether the node represented by the node details is the coordinator.
isCoordinator() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Used to query if the current node is the coordinator.
isEnabled() - Method in class org.wso2.broker.coordination.BrokerHaConfiguration
isNewNode() - Method in class org.wso2.broker.coordination.node.NodeHeartbeatData: Getter method for isNewNode.
isStartCalled() - Method in class org.wso2.broker.coordination.BasicHaListener: Method to retrieve whether start was called explicitly.

L

LAST_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
LOGGER - Static variable in class org.wso2.broker.coordination.AbstractHaStrategy: Class logger.
lostCoordinatorState() - Method in interface org.wso2.broker.coordination.rdbms.RdbmsCoordinationListener: Method to be invoked once the node loses coordinator state.
lostCoordinatorState() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy: Method to be invoked once the node loses coordinator state.

M

markNodeAsNotNew(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Method to indicate that the coordinator detected a node addition.

N

NAMESPACE - Static variable in class org.wso2.broker.coordination.BrokerHaConfiguration: Namespace used in the config file.
NODE_ID - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
NODE_IDENTIFIER - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
NodeDetail - Class in org.wso2.broker.coordination.node: Hold information related to a node to be used with coordination.
NodeDetail(String, boolean) - Constructor for class org.wso2.broker.coordination.node.NodeDetail: Constructor for node details.
NodeHeartbeatData - Class in org.wso2.broker.coordination.node: Hold information related to a node heartbeat entry.
NodeHeartbeatData(String, long, boolean) - Constructor for class org.wso2.broker.coordination.node.NodeHeartbeatData: Constructor for NodeHeartbeatData.
notifyBecameActiveNode() - Method in class org.wso2.broker.coordination.AbstractHaStrategy: Method to notify becoming the active node to all listeners.
notifyBecamePassiveNode() - Method in class org.wso2.broker.coordination.AbstractHaStrategy: Method to notify becoming the passive node to all listeners.

O

org.wso2.broker.coordination - package org.wso2.broker.coordination
org.wso2.broker.coordination.node - package org.wso2.broker.coordination.node
org.wso2.broker.coordination.rdbms - package org.wso2.broker.coordination.rdbms

P

pause() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy
PS_DELETE_COORDINATOR - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to delete the coordinator entry.
PS_DELETE_NODE_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to delete the node heart beat entry for the specified node.
PS_GET_ALL_NODE_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to retrieve the last updated node heartbeats of all the nodes.
PS_GET_COORDINATOR_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to get the heartbeat of the coordinator.
PS_GET_COORDINATOR_NODE_ID - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to get the node ID of the coordinator node.
PS_GET_COORDINATOR_ROW_FOR_NODE_ID - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to check if the specified node is the coordinator.
PS_INSERT_COORDINATOR_ROW - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to insert the coordinator row.
PS_INSERT_NODE_HEARTBEAT_ROW - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to insert the node heartbeat entry of a new node.
PS_MARK_NODE_NOT_NEW - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to mark the specified node as not new.
PS_UPDATE_COORDINATOR_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to update the coordinator heartbeat entry.
PS_UPDATE_NODE_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants: Prepared statement to update the node heartbeat of the specified node.

R

RdbmsCoordinationConstants - Class in org.wso2.broker.coordination.rdbms: Common properties, prepared statements, table names, column names and tasks for RDBMS coordination.
RdbmsCoordinationConstants() - Constructor for class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
RdbmsCoordinationDaoImpl - Class in org.wso2.broker.coordination.rdbms: Abstraction of the underlying database used with RDBMS coordination.
RdbmsCoordinationDaoImpl(DataSource) - Constructor for class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Default constructor which uses the provided datasource.
RdbmsCoordinationListener - Interface in org.wso2.broker.coordination.rdbms: Optional interface that declares methods to be run when the coordinator changes.
RdbmsCoordinationStrategy - Class in org.wso2.broker.coordination.rdbms: RdbmsCoordinationStrategy uses a RDBMS based approached to identify membership events related to the cluster.
RdbmsCoordinationStrategy(RdbmsCoordinationDaoImpl, Map<String, String>) - Constructor for class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Default constructor.
RdbmsHaStrategy - Class in org.wso2.broker.coordination.rdbms: The RDBMS coordination based HA strategy implementation.
RdbmsHaStrategy() - Constructor for class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy
registerListener(HaListener, int) - Method in class org.wso2.broker.coordination.AbstractHaStrategy: Method to register a listener to listen on notifications for node state changes with priority level.
registerListener(HaListener, int) - Method in interface org.wso2.broker.coordination.HaStrategy: Method to register a listener to listen on notifications for node state changes with priority level.
removeCoordinationListener(RdbmsCoordinationListener) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Method to remove a listener set expecting notifications regarding changes in the coordinator.
removeCoordinator() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Remove current coordinator entry from database.
removeNodeHeartbeat(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Remove heartbeat entry for the given node.
resume() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy
rollback(Connection, String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: On database update failure try to rollback.

S

setEnabled(boolean) - Method in class org.wso2.broker.coordination.BrokerHaConfiguration
setOptions(Map<String, String>) - Method in class org.wso2.broker.coordination.BrokerHaConfiguration
setStartCalled() - Method in class org.wso2.broker.coordination.BasicHaListener: Method to indicate that start was called explicitly.
setStrategy(String) - Method in class org.wso2.broker.coordination.BrokerHaConfiguration
setup(StartupContext) - Method in interface org.wso2.broker.coordination.HaStrategy: Setup based on StartupContext if required (eg:- read configs).
setup(StartupContext) - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy: Setup based on StartupContext if required (eg:- read configs).
start() - Method in interface org.wso2.broker.coordination.CoordinationStrategy: Meant to be invoked when the coordination algorithm should start working.
start() - Method in interface org.wso2.broker.coordination.HaStrategy: Meant to be invoked when the HA strategy should start.
start() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Meant to be invoked when the coordination algorithm should start working.
start() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy: Meant to be invoked when the HA strategy should start.
stop() - Method in class org.wso2.broker.coordination.AbstractHaStrategy: Meant to be invoked when the HaStrategy should stop.
stop() - Method in interface org.wso2.broker.coordination.CoordinationStrategy: Meant to be invoked when the coordination algorithm should stop working.
stop() - Method in interface org.wso2.broker.coordination.HaStrategy: Meant to be invoked when the HaStrategy should stop.
stop() - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationStrategy: Meant to be invoked when the coordination algorithm should stop working.
stop() - Method in class org.wso2.broker.coordination.rdbms.RdbmsHaStrategy: Meant to be invoked when the HaStrategy should stop.

T

TASK_ADD_COORDINATOR_ROW - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_ADD_NODE_ROW - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_CHECK_IF_COORDINATOR - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_GET_ALL_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_GET_COORDINATOR_INFORMATION - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_MARK_NODE_NOT_NEW - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_REMOVE_COORDINATOR - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_REMOVE_NODE_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_UPDATE_COORDINATOR_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
TASK_UPDATE_NODE_HEARTBEAT - Static variable in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationConstants
toString() - Method in class org.wso2.broker.coordination.BrokerHaConfiguration

U

unregisterListener(HaListener) - Method in class org.wso2.broker.coordination.AbstractHaStrategy: Method to unregister a listener registered to listen on notifications for node state changes.
unregisterListener(HaListener) - Method in interface org.wso2.broker.coordination.HaStrategy: Method to unregister a listener registered to listen on notifications for node state changes.
updateCoordinatorHeartbeat(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Update coordinator heartbeat value to current time.
updateNodeHeartbeat(String) - Method in class org.wso2.broker.coordination.rdbms.RdbmsCoordinationDaoImpl: Method to update the node heartbeat value to the current time.

A B C D G H I L M N O P R S T U