com.opendxl.client

Class Broker

java.lang.Object

com.opendxl.client.Broker

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<Broker>

public class Broker
extends java.lang.Object
implements java.lang.Comparable<Broker>, java.lang.Cloneable

The class Broker represents a DXL message broker.

Instances of this class are created for the purpose of connecting to the DXL fabric.

There are a couple of ways to create Broker instances:

• Invoking the Broker constructor directly
• When creating a DxlClientConfig object via the DxlClientConfig.createDxlConfigFromFile(java.lang.String) static method

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_SEPARATOR Constant for parse separator
static java.lang.String	SSL_PROTOCOL Constant for ssl protocol
static java.lang.String	WSS_PROTOCOL The WSS protocol identifier

Constructor Summary

Constructors

Constructor and Description
Broker(java.lang.String uniqueId, int port, java.lang.String hostName, java.lang.String ipAddress) Constructor for the Broker
Broker(java.lang.String uniqueId, int port, java.lang.String hostName, java.lang.String ipAddress, boolean useWebSockets) Constructor for the Broker

Method Summary

Modifier and Type	Method and Description
Broker	clone() Creates a clone of the Broker
int	compareTo(Broker that)
boolean	equals(java.lang.Object obj)
java.lang.String	getHostName() Returns the host name or IP address of the broker
java.lang.String	getIpAddress() Returns a valid IP address for the broker.
int	getPort() Returns the port of the broker
java.lang.String	getProtocol() Returns the connection protocol of the broker.
java.lang.Long	getResponseTime() Returns the response time for the broker (essentially the ping time)
java.lang.String	getUniqueId() Returns a unique identifier for the broker, used to identify the broker in log messages, etc.
int	hashCode()
boolean	isResponseFromIpAddress() Returns whether the response time is for the broker's IP address
static Broker	parse(java.lang.String configString) Constructs and returns a Broker for the specified configuration string of the following format:
static Broker	parse(java.lang.String configString, boolean useWebSockets) Constructs and returns a Broker for the specified configuration string of the following format:
static Broker	parse(java.lang.String configString, java.lang.String protocol) Constructs and returns a Broker for the specified protocol and configuration string of the following format:
void	setHostName(java.lang.String hostName) Sets the host name or IP address of the broker
void	setIpAddress(java.lang.String ipAddress) Sets the IP address for the broker
void	setPort(int port) Set the port of the broker
void	setProtocol(java.lang.String protocol) Set the connection protocol of the broker.
void	setUniqueId(java.lang.String uniqueId) Sets the unique identifier for the broker, used to identify the broker in log messages, etc.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SSL_PROTOCOL

public static final java.lang.String SSL_PROTOCOL

Constant for ssl protocol

See Also:

Constant Field Values

WSS_PROTOCOL

public static final java.lang.String WSS_PROTOCOL

The WSS protocol identifier

See Also:

Constant Field Values

FIELD_SEPARATOR

public static final java.lang.String FIELD_SEPARATOR

Constant for parse separator

See Also:

Constant Field Values

Constructor Detail

Broker

public Broker(java.lang.String uniqueId,
              int port,
              java.lang.String hostName,
              java.lang.String ipAddress)

Constructor for the Broker

Parameters:

uniqueId - A unique identifier for the broker, used to identify the broker in log messages, etc.

port - The port of the broker

hostName - The host name or IP address of the broker (required)

ipAddress - A valid IP address for the broker. This allows for both the host name and IP address to be used when connecting to the broker (optional).

Broker

public Broker(java.lang.String uniqueId,
              int port,
              java.lang.String hostName,
              java.lang.String ipAddress,
              boolean useWebSockets)

Constructor for the Broker

Parameters:

uniqueId - A unique identifier for the broker, used to identify the broker in log messages, etc.

port - The port of the broker

hostName - The host name or IP address of the broker (required)

ipAddress - A valid IP address for the broker. This allows for both the host name and IP address to be used when connecting to the broker (optional).

useWebSockets - Whether to use WebSockets or regular MQTT over tcp when connecting to a broker

Method Detail

clone

public Broker clone()
             throws java.lang.CloneNotSupportedException

Creates a clone of the Broker

Overrides:

clone in class java.lang.Object

Returns:

The cloned Broker

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Broker that)

Specified by:

compareTo in interface java.lang.Comparable<Broker>

getUniqueId

public java.lang.String getUniqueId()

Returns a unique identifier for the broker, used to identify the broker in log messages, etc.

Returns:

A unique identifier for the broker, used to identify the broker in log messages, etc.

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

Sets the unique identifier for the broker, used to identify the broker in log messages, etc.

Parameters:

uniqueId - The unique identifier for the broker, used to identify the broker in log messages, etc.

getHostName

public java.lang.String getHostName()

Returns the host name or IP address of the broker

Returns:

The host name or IP address of the broker

setHostName

public void setHostName(java.lang.String hostName)

Sets the host name or IP address of the broker

Parameters:

hostName - The host name or IP address of the broker

getIpAddress

public java.lang.String getIpAddress()

Returns a valid IP address for the broker. This allows for both the host name and IP address to be used when connecting to the broker.

Returns:

A valid IP address for the broker

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

Sets the IP address for the broker

Parameters:

ipAddress - The IP address for the broker

getProtocol

public java.lang.String getProtocol()

Returns the connection protocol of the broker.

Returns:

The connection protocol of the broker

setProtocol

public void setProtocol(java.lang.String protocol)

Set the connection protocol of the broker.

Parameters:

protocol - The connection protocol of the broker (wss or ssl).

getPort

public int getPort()

Returns the port of the broker

Returns:

The port of the broker

setPort

public void setPort(int port)

Set the port of the broker

Parameters:

port - The port of the broker

getResponseTime

public java.lang.Long getResponseTime()

Returns the response time for the broker (essentially the ping time)

Returns:

The response time for the broker (essentially the ping time)

isResponseFromIpAddress

public boolean isResponseFromIpAddress()

Returns whether the response time is for the broker's IP address

Returns:

Whether the response time is for the broker's IP address

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

parse

public static Broker parse(java.lang.String configString)
                    throws MalformedBrokerException

Constructs and returns a Broker for the specified configuration string of the following format:

[UniqueId];[Port];[HostName];[IpAddress]

Parameters:

configString - The configuration string

Returns:

A Broker corresponding to the specified configuration string

Throws:

MalformedBrokerException - If the format is malformed

parse

public static Broker parse(java.lang.String configString,
                           java.lang.String protocol)
                    throws MalformedBrokerException

Constructs and returns a Broker for the specified protocol and configuration string of the following format:

[UniqueId];[Port];[HostName];[IpAddress]

Parameters:

configString - The configuration string

protocol - The protocol to use when connecting to a broker

Returns:

A Broker corresponding to the specified configuration string and protocol

Throws:

MalformedBrokerException - If the format is malformed

parse

public static Broker parse(java.lang.String configString,
                           boolean useWebSockets)
                    throws MalformedBrokerException

Constructs and returns a Broker for the specified configuration string of the following format:

[UniqueId];[Port];[HostName];[IpAddress]

Parameters:

configString - The configuration string

useWebSockets - Whether to use WebSockets or regular MQTT over tcp when connecting to a broker

Returns:

A Broker corresponding to the specified configuration string

Throws:

MalformedBrokerException - If the format is malformed