com.cloudhopper.mq.broker

Class RemoteQueueInfo

java.lang.Object

com.cloudhopper.mq.broker.RemoteQueueInfo

All Implemented Interfaces:

Comparable<RemoteQueueInfo>

public class RemoteQueueInfo
extends Object
implements Comparable<RemoteQueueInfo>

Immutable information about a remote queue on one or more remote brokers...

Author:

joelauer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteQueueInfo.Entry
static class	RemoteQueueInfo.Event

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_AVAILABLE
static int	STATE_NOT_AVAILABLE all possible states of a RemoteQueue
static String[]	STATES

Constructor Summary

Constructors

Constructor and Description
RemoteQueueInfo(String name, int localAreaId)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all internal data structures such as remote brokers and any load balancer lists.
int	compareTo(RemoteQueueInfo o)
boolean	equals(Object otherObject)
List<com.cloudhopper.commons.util.LoadBalancedList.Node<String>>	getFailoverList()
int	getFailoverSize() Gets the total number of failover RemoteBrokers that can consume this queue.
long	getLastStateChangedTime()
int	getLocalAreaId()
String	getName()
String	getNextRemoteBroker() Gets the URL for the next RemoteBroker to send a request to.
List<com.cloudhopper.commons.util.LoadBalancedList.Node<String>>	getPrimaryList()
int	getPrimarySize() Gets the total number of primary RemoteBrokers that can consume this queue.
ConcurrentHashMap<String,RemoteQueueInfo.Entry>	getRemoteBrokers()
int	getSize() Gets the total number of RemoteBrokers (either primary or failover) that can consume this queue.
int	getState()
int	hashCode()
boolean	isAvailable()
boolean	isNotAvailable()
RemoteQueueInfo.Event	setRemoteBrokerWeight(RemoteBrokerInfo bi, int weight) Sets or adds the RemoteBroker and either updates or sets the weight of it to the new value.
protected boolean	setState(int value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STATE_NOT_AVAILABLE

public static final int STATE_NOT_AVAILABLE

all possible states of a RemoteQueue

See Also:

Constant Field Values

STATE_AVAILABLE

public static final int STATE_AVAILABLE

See Also:

Constant Field Values

STATES

public static final String[] STATES

Constructor Detail

RemoteQueueInfo

public RemoteQueueInfo(String name,
               int localAreaId)

Method Detail

clear

public void clear()

Clears all internal data structures such as remote brokers and any load balancer lists.

getName

public String getName()

getLocalAreaId

public int getLocalAreaId()

getRemoteBrokers

public ConcurrentHashMap<String,RemoteQueueInfo.Entry> getRemoteBrokers()

getSize

public int getSize()

Gets the total number of RemoteBrokers (either primary or failover) that can consume this queue.

Returns:

The total number of RemoteBrokers that can consume this queue

getPrimarySize

public int getPrimarySize()

Gets the total number of primary RemoteBrokers that can consume this queue. A primary RemoteBroker is a broker that is in the local brokers area.

Returns:

The total number of primary RemoteBrokers that can consume this queue

getPrimaryList

public List<com.cloudhopper.commons.util.LoadBalancedList.Node<String>> getPrimaryList()

getFailoverSize

public int getFailoverSize()

Gets the total number of failover RemoteBrokers that can consume this queue. A failover RemoteBroker is a broker that isn't in the local brokers area.

Returns:

The total number of failover RemoteBrokers that can consume this queue

getFailoverList

public List<com.cloudhopper.commons.util.LoadBalancedList.Node<String>> getFailoverList()

getNextRemoteBroker

public String getNextRemoteBroker()

Gets the URL for the next RemoteBroker to send a request to. Internally uses the primary and failover load balancer lists.

Returns:

The next RemoteBroker URL to send to or null if no more RemoteBrokers are available.

setRemoteBrokerWeight

public RemoteQueueInfo.Event setRemoteBrokerWeight(RemoteBrokerInfo bi,
                                          int weight)

Sets or adds the RemoteBroker and either updates or sets the weight of it to the new value.

Parameters:

bi - The RemoteBroker we're setting the weight for

weight - The new or updated weight of the broker. Setting to zero removes the RemoteBroker from our internal structures.

Returns:

True if the weight caused a state change, otherwise false.

getState

public int getState()

setState

protected boolean setState(int value)

getLastStateChangedTime

public long getLastStateChangedTime()

isAvailable

public boolean isAvailable()

isNotAvailable

public boolean isNotAvailable()

equals

public boolean equals(Object otherObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(RemoteQueueInfo o)

Specified by:

compareTo in interface Comparable<RemoteQueueInfo>

toString

public String toString()

Overrides:

toString in class Object