Package org.apache.activemq.command

Class BrokerInfo

java.lang.Object

org.apache.activemq.command.BaseCommand

org.apache.activemq.command.BrokerInfo

All Implemented Interfaces:

Command, DataStructure

public class BrokerInfo
extends BaseCommand

When a client connects to a broker, the broker send the client a BrokerInfo so that the client knows which broker node he's talking to and also any peers that the node has in his cluster. This is the broker helping the client out in discovering other nodes in the cluster.

Field Summary

Fields

Modifier and Type	Field	Description
static byte	DATA_STRUCTURE_TYPE

Fields inherited from class org.apache.activemq.command.BaseCommand

commandId, responseRequired

Constructor Summary

Constructors

Constructor	Description
BrokerInfo()

Method Summary

Modifier and Type	Method	Description
BrokerInfo	copy()
int	decrementRefCount()
BrokerId	getBrokerId()
String	getBrokerName()
String	getBrokerUploadUrl()	The URL to use when uploading BLOBs to the broker or some other external file/http server
String	getBrokerURL()
long	getConnectionId()	The broker assigns a each connection it accepts a connection id.
byte	getDataStructureType()
String	getNetworkProperties()
BrokerInfo[]	getPeerBrokerInfos()
Properties	getProperties()
int	getRefCount()
void	incrementRefCount()
boolean	isBrokerInfo()
boolean	isDuplexConnection()
boolean	isFaultTolerantConfiguration()
boolean	isMasterBroker()
boolean	isNetworkConnection()
boolean	isPassiveSlave()
boolean	isSlaveBroker()
void	setBrokerId(BrokerId brokerId)
void	setBrokerName(String brokerName)
void	setBrokerUploadUrl(String brokerUploadUrl)
void	setBrokerURL(String brokerURL)
void	setConnectionId(long connectionId)
void	setDuplexConnection(boolean duplexConnection)
void	setFaultTolerantConfiguration(boolean faultTolerantConfiguration)
void	setMasterBroker(boolean masterBroker)
void	setNetworkConnection(boolean networkConnection)
void	setNetworkProperties(String networkProperties)
void	setPassiveSlave(boolean value)
void	setPeerBrokerInfos(BrokerInfo[] peerBrokerInfos)
void	setSlaveBroker(boolean slaveBroker)
Response	visit(CommandVisitor visitor)

Methods inherited from class org.apache.activemq.command.BaseCommand

copy, getCommandId, getFrom, getTo, isConnectionControl, isConsumerControl, isMarshallAware, isMessage, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATA_STRUCTURE_TYPE

public static final byte DATA_STRUCTURE_TYPE

See Also:

Constant Field Values

Constructor Detail

BrokerInfo

public BrokerInfo()

Method Detail

copy

public BrokerInfo copy()

isBrokerInfo

public boolean isBrokerInfo()

Specified by:

isBrokerInfo in interface Command

Overrides:

isBrokerInfo in class BaseCommand

getDataStructureType

public byte getDataStructureType()

Returns:

The type of the data structure

getBrokerId

public BrokerId getBrokerId()

setBrokerId

public void setBrokerId(BrokerId brokerId)

getBrokerURL

public String getBrokerURL()

setBrokerURL

public void setBrokerURL(String brokerURL)

getPeerBrokerInfos

public BrokerInfo[] getPeerBrokerInfos()

setPeerBrokerInfos

public void setPeerBrokerInfos(BrokerInfo[] peerBrokerInfos)

getBrokerName

public String getBrokerName()

setBrokerName

public void setBrokerName(String brokerName)

visit

public Response visit(CommandVisitor visitor)
               throws Exception

Throws:

Exception

isSlaveBroker

public boolean isSlaveBroker()

setSlaveBroker

public void setSlaveBroker(boolean slaveBroker)

isMasterBroker

public boolean isMasterBroker()

setMasterBroker

public void setMasterBroker(boolean masterBroker)

Parameters:

masterBroker - The masterBroker to set.

isFaultTolerantConfiguration

public boolean isFaultTolerantConfiguration()

Returns:

Returns the faultTolerantConfiguration.

setFaultTolerantConfiguration

public void setFaultTolerantConfiguration(boolean faultTolerantConfiguration)

Parameters:

faultTolerantConfiguration - The faultTolerantConfiguration to set.

isDuplexConnection

public boolean isDuplexConnection()

Returns:

the duplexConnection

setDuplexConnection

public void setDuplexConnection(boolean duplexConnection)

Parameters:

duplexConnection - the duplexConnection to set

isNetworkConnection

public boolean isNetworkConnection()

Returns:

the networkConnection

setNetworkConnection

public void setNetworkConnection(boolean networkConnection)

Parameters:

networkConnection - the networkConnection to set

getConnectionId

public long getConnectionId()

The broker assigns a each connection it accepts a connection id.

setConnectionId

public void setConnectionId(long connectionId)

getBrokerUploadUrl

public String getBrokerUploadUrl()

The URL to use when uploading BLOBs to the broker or some other external file/http server

setBrokerUploadUrl

public void setBrokerUploadUrl(String brokerUploadUrl)

getNetworkProperties

public String getNetworkProperties()

Returns:

the networkProperties

setNetworkProperties

public void setNetworkProperties(String networkProperties)

Parameters:

networkProperties - the networkProperties to set

isPassiveSlave

public boolean isPassiveSlave()

setPassiveSlave

public void setPassiveSlave(boolean value)

getProperties

public Properties getProperties()

getRefCount

public int getRefCount()

incrementRefCount

public void incrementRefCount()

decrementRefCount

public int decrementRefCount()