Package org.apache.activemq.transport.mqtt

Class MQTTTransportFilter

java.lang.Object

org.apache.activemq.transport.TransportFilter

org.apache.activemq.transport.mqtt.MQTTTransportFilter

All Implemented Interfaces:

Service, MQTTTransport, Transport, TransportListener

public class MQTTTransportFilter
extends TransportFilter
implements MQTTTransport

The MQTTTransportFilter normally sits on top of a TcpTransport that has been configured with the StompWireFormat and is used to convert MQTT commands to ActiveMQ commands. All of the conversion work is done by delegating to the MQTTProtocolConverter

Field Summary

Fields inherited from class org.apache.activemq.transport.TransportFilter

next, transportListener

Constructor Summary

Constructors

Constructor	Description
MQTTTransportFilter(Transport next, WireFormat wireFormat, BrokerService brokerService)

Method Summary

Modifier and Type	Method	Description
int	getActiveMQSubscriptionPrefetch()
long	getConnectAttemptTimeout()
long	getDefaultKeepAlive()
MQTTInactivityMonitor	getInactivityMonitor()
int	getMaxFrameSize()
X509Certificate[]	getPeerCertificates()
boolean	getPublishDollarTopics()
String	getSubscriptionStrategy()
MQTTWireFormat	getWireFormat()	Retrieves the WireFormat instance associated with this Transport instance.
boolean	isTrace()
void	onCommand(Object command)	called to process a command
void	oneway(Object o)	A one way asynchronous send
void	onException(IOException error)	An unrecoverable exception has occured on the transport
void	sendToActiveMQ(Command command)
void	sendToMQTT(org.fusesource.mqtt.codec.MQTTFrame command)
void	setActiveMQSubscriptionPrefetch(int activeMQSubscriptionPrefetch)	set the default prefetch size when mapping the MQTT subscription to an ActiveMQ one The default = 1
void	setConnectAttemptTimeout(long connectTimeout)	Sets the timeout value used to fail a connection if no CONNECT frame is read in the given interval.
void	setDefaultKeepAlive(long defaultHeartBeat)
void	setInactivityMonitor(MQTTInactivityMonitor monitor)
void	setMaxFrameSize(int maxFrameSize)	Sets the maximum frame size for an incoming MQTT frame.
void	setPeerCertificates(X509Certificate[] certificates)	Sets the certificates provided by the connected peer.
void	setPublishDollarTopics(boolean publishDollarTopics)
void	setSubscriptionStrategy(String name)
void	setTrace(boolean trace)
void	start()
void	stop()

Methods inherited from class org.apache.activemq.transport.TransportFilter

asyncRequest, getNext, getReceiveCounter, getRemoteAddress, getTransportListener, isConnected, isDisposed, isFaultTolerant, isReconnectSupported, isUpdateURIsSupported, narrow, reconnect, request, request, setTransportListener, toString, transportInterupted, transportResumed, updateURIs

Methods inherited from class java.lang.Object

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

Constructor Detail

MQTTTransportFilter

public MQTTTransportFilter(Transport next,
                           WireFormat wireFormat,
                           BrokerService brokerService)

Method Detail

oneway

public void oneway(Object o)
            throws IOException

Description copied from interface: Transport

A one way asynchronous send

Specified by:

oneway in interface Transport

Overrides:

oneway in class TransportFilter

Throws:

IOException

onCommand

public void onCommand(Object command)

Description copied from interface: TransportListener

called to process a command

Specified by:

onCommand in interface TransportListener

Overrides:

onCommand in class TransportFilter

sendToActiveMQ

public void sendToActiveMQ(Command command)

Specified by:

sendToActiveMQ in interface MQTTTransport

sendToMQTT

public void sendToMQTT(org.fusesource.mqtt.codec.MQTTFrame command)
                throws IOException

Specified by:

sendToMQTT in interface MQTTTransport

Throws:

IOException

start

public void start()
           throws Exception

Specified by:

start in interface Service

Overrides:

start in class TransportFilter

Throws:

Exception

See Also:

Service.start()

stop

public void stop()
          throws Exception

Specified by:

stop in interface MQTTTransport

Specified by:

stop in interface Service

Overrides:

stop in class TransportFilter

Throws:

Exception

See Also:

Service.stop()

getPeerCertificates

public X509Certificate[] getPeerCertificates()

Specified by:

getPeerCertificates in interface MQTTTransport

Specified by:

getPeerCertificates in interface Transport

Overrides:

getPeerCertificates in class TransportFilter

Returns:

the Certificates provided by the peer, or null if not a secure channel.

isTrace

public boolean isTrace()

setTrace

public void setTrace(boolean trace)

getInactivityMonitor

public MQTTInactivityMonitor getInactivityMonitor()

Specified by:

getInactivityMonitor in interface MQTTTransport

setInactivityMonitor

public void setInactivityMonitor(MQTTInactivityMonitor monitor)

getWireFormat

public MQTTWireFormat getWireFormat()

Description copied from interface: Transport

Retrieves the WireFormat instance associated with this Transport instance.

Specified by:

getWireFormat in interface MQTTTransport

Specified by:

getWireFormat in interface Transport

Overrides:

getWireFormat in class TransportFilter

Returns:

the WireFormat in use.

onException

public void onException(IOException error)

Description copied from interface: TransportListener

An unrecoverable exception has occured on the transport

Specified by:

onException in interface MQTTTransport

Specified by:

onException in interface TransportListener

Overrides:

onException in class TransportFilter

getDefaultKeepAlive

public long getDefaultKeepAlive()

setDefaultKeepAlive

public void setDefaultKeepAlive(long defaultHeartBeat)

getConnectAttemptTimeout

public long getConnectAttemptTimeout()

Returns:

the timeout value used to fail a connection if no CONNECT frame read.

setConnectAttemptTimeout

public void setConnectAttemptTimeout(long connectTimeout)

Sets the timeout value used to fail a connection if no CONNECT frame is read in the given interval.

Parameters:

connectTimeout - the connection frame received timeout value.

getPublishDollarTopics

public boolean getPublishDollarTopics()

setPublishDollarTopics

public void setPublishDollarTopics(boolean publishDollarTopics)

getSubscriptionStrategy

public String getSubscriptionStrategy()

setSubscriptionStrategy

public void setSubscriptionStrategy(String name)

getActiveMQSubscriptionPrefetch

public int getActiveMQSubscriptionPrefetch()

setActiveMQSubscriptionPrefetch

public void setActiveMQSubscriptionPrefetch(int activeMQSubscriptionPrefetch)

set the default prefetch size when mapping the MQTT subscription to an ActiveMQ one The default = 1

Parameters:

activeMQSubscriptionPrefetch - set the prefetch for the corresponding ActiveMQ subscription

getMaxFrameSize

public int getMaxFrameSize()

Returns:

the maximum number of bytes a single MQTT message frame is allowed to be.

setMaxFrameSize

public void setMaxFrameSize(int maxFrameSize)

Sets the maximum frame size for an incoming MQTT frame. The protocl limit is 256 megabytes and this value cannot be set higher.

Parameters:

maxFrameSize - the maximum allowed frame size for a single MQTT frame.

setPeerCertificates

public void setPeerCertificates(X509Certificate[] certificates)

Description copied from interface: Transport

Sets the certificates provided by the connected peer.

Specified by:

setPeerCertificates in interface MQTTTransport

Specified by:

setPeerCertificates in interface Transport

Overrides:

setPeerCertificates in class TransportFilter

Parameters:

certificates - the Certificates provided by the peer.