com.cloudhopper.mq.broker

Class RemoteBrokerInfo

java.lang.Object

com.cloudhopper.mq.broker.RemoteBrokerInfo

All Implemented Interfaces:

Comparable<RemoteBrokerInfo>

public class RemoteBrokerInfo
extends Object
implements Comparable<RemoteBrokerInfo>

Immutable information about a remote broker.

Author:

joelauer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RemoteBrokerInfo(String url)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addRemoteQueue(String queueName)
void	clear() Clears all internal data structures such as remote brokers and any load balancer lists.
void	clearRemoteQueues()
int	compareTo(RemoteBrokerInfo o)
boolean	equals(Object otherObject)
int	getAreaId()
int	getId()
long	getLastAvailableTime() Gets the last time this had its state set to available (even if it was previously available).
String	getLastErrorMessage()
long	getLastMonitorTime()
long	getLastStateChangedTime()
Set<String>	getRemoteQueues() Returns a set of all RemoteQueues by name that are mapped to this RemoteBroker.
long	getSent()
int	getState()
String	getUrl()
byte	getVersion()
int	hashCode()
void	incrementSent(int count)
boolean	isAvailable() Checks whether this remote broker is available and ready to have items from the queue forwarded to it.
boolean	isNotAvailable() Checks whether this remote broker is not available.
boolean	removeRemoteQueue(String queueName)
protected void	setAreaId(int value)
protected void	setId(int value)
protected void	setLastAvailableTime(long value)
void	setLastErrorMessage(String value)
protected void	setLastMonitorTime(long value)
protected boolean	setState(int value) Sets the state of the remote broker to the new value.
void	setVersion(byte 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 RemoteBroker

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

RemoteBrokerInfo

public RemoteBrokerInfo(String url)

Method Detail

clear

public void clear()

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

getUrl

public String getUrl()

getRemoteQueues

public Set<String> getRemoteQueues()

Returns a set of all RemoteQueues by name that are mapped to this RemoteBroker.

Returns:

A Set of all remote queue names mapped to this broker

addRemoteQueue

public boolean addRemoteQueue(String queueName)

removeRemoteQueue

public boolean removeRemoteQueue(String queueName)

clearRemoteQueues

public void clearRemoteQueues()

getId

public int getId()

setId

protected void setId(int value)

getAreaId

public int getAreaId()

setAreaId

protected void setAreaId(int value)

getLastMonitorTime

public long getLastMonitorTime()

setLastMonitorTime

protected void setLastMonitorTime(long value)

getLastAvailableTime

public long getLastAvailableTime()

Gets the last time this had its state set to available (even if it was previously available). Let's you track that an update was made even if it didn't change the actual state.

Returns:

The last time this had its state set to available

setLastAvailableTime

protected void setLastAvailableTime(long value)

getState

public int getState()

incrementSent

public void incrementSent(int count)

getSent

public long getSent()

setState

protected boolean setState(int value)

Sets the state of the remote broker to the new value. If the state was changed, it returns true. If the state is the same, returns false.

Parameters:

value -

Returns:

true if changed

getLastStateChangedTime

public long getLastStateChangedTime()

setLastErrorMessage

public void setLastErrorMessage(String value)

getLastErrorMessage

public String getLastErrorMessage()

setVersion

public void setVersion(byte value)

getVersion

public byte getVersion()

isAvailable

public boolean isAvailable()

Checks whether this remote broker is available and ready to have items from the queue forwarded to it.

Returns:

true if the broker is available

isNotAvailable

public boolean isNotAvailable()

Checks whether this remote broker is not available.

Returns:

true if the broker isn't available

equals

public boolean equals(Object otherObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(RemoteBrokerInfo o)

Specified by:

compareTo in interface Comparable<RemoteBrokerInfo>

toString

public String toString()

Overrides:

toString in class Object