MQTTProtocolManager (ActiveMQ Artemis MQTT Protocol 2.17.0 API)

java.lang.Object
- org.apache.activemq.artemis.spi.core.protocol.AbstractProtocolManager<io.netty.handler.codec.mqtt.MqttMessage,MQTTInterceptor,MQTTConnection>
- - org.apache.activemq.artemis.core.protocol.mqtt.MQTTProtocolManager

All Implemented Interfaces:: org.apache.activemq.artemis.core.server.management.NotificationListener, ProtocolManager<MQTTInterceptor>

public class MQTTProtocolManager
extends AbstractProtocolManager<io.netty.handler.codec.mqtt.MqttMessage,MQTTInterceptor,MQTTConnection>
implements org.apache.activemq.artemis.core.server.management.NotificationListener

MQTTProtocolManager

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptsNoHandshake()`
`void`	`addChannelHandlers(io.netty.channel.ChannelPipeline pipeline)`
`MQTTConnection`	`addConnectedClient(String clientId, MQTTConnection connection)`
`ConnectionEntry`	`createConnectionEntry(Acceptor acceptorUsed, Connection connection)`
`Map<String,MQTTConnection>`	`getConnectedClients()` For DEBUG only
`ProtocolManagerFactory`	`getFactory()`
`MQTTSessionState`	`getSessionState(String clientId)`
`Map<String,MQTTSessionState>`	`getSessionStates()`
`void`	`handleBuffer(RemotingConnection connection, ActiveMQBuffer buffer)`
`void`	`handshake(org.apache.activemq.artemis.core.remoting.impl.netty.NettyServerConnection connection, ActiveMQBuffer buffer)`
`String`	`invokeIncoming(io.netty.handler.codec.mqtt.MqttMessage mqttMessage, MQTTConnection connection)`
`String`	`invokeOutgoing(io.netty.handler.codec.mqtt.MqttMessage mqttMessage, MQTTConnection connection)`
`boolean`	`isClientConnected(String clientId, MQTTConnection connection)`
`boolean`	`isProtocol(byte[] array)` The protocol handler passes us an 8 byte long array from the transport.
`void`	`onNotification(org.apache.activemq.artemis.core.server.management.Notification notification)`
`void`	`removeConnectedClient(String clientId)`
`void`	`removeHandler(String name)`
`MQTTSessionState`	`removeSessionState(String clientId)`
`void`	`updateInterceptors(List incoming, List outgoing)`
`List<String>`	`websocketSubprotocolIdentifiers()`

Methods inherited from class org.apache.activemq.artemis.spi.core.protocol.AbstractProtocolManager
getPrefixes, getSecurityDomain, invokeInterceptors, setAnycastPrefix, setMulticastPrefix, setSecurityDomain

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - onNotification
```
public void onNotification(org.apache.activemq.artemis.core.server.management.Notification notification)
```
    Specified by:
    
    onNotification in interface org.apache.activemq.artemis.core.server.management.NotificationListener
  - getFactory
```
public ProtocolManagerFactory getFactory()
```
    Specified by:
    
    getFactory in interface ProtocolManager<MQTTInterceptor>
  - updateInterceptors
```
public void updateInterceptors(List incoming,
                               List outgoing)
```
    Specified by:
    
    updateInterceptors in interface ProtocolManager<MQTTInterceptor>
  - createConnectionEntry
```
public ConnectionEntry createConnectionEntry(Acceptor acceptorUsed,
                                             Connection connection)
```
    Specified by:
    
    createConnectionEntry in interface ProtocolManager<MQTTInterceptor>
  - acceptsNoHandshake
```
public boolean acceptsNoHandshake()
```
    Specified by:
    
    acceptsNoHandshake in interface ProtocolManager<MQTTInterceptor>
  - removeHandler
```
public void removeHandler(String name)
```
    Specified by:
    
    removeHandler in interface ProtocolManager<MQTTInterceptor>
  - handleBuffer
```
public void handleBuffer(RemotingConnection connection,
                         ActiveMQBuffer buffer)
```
    Specified by:
    
    handleBuffer in interface ProtocolManager<MQTTInterceptor>
  - addChannelHandlers
```
public void addChannelHandlers(io.netty.channel.ChannelPipeline pipeline)
```
    Specified by:
    
    addChannelHandlers in interface ProtocolManager<MQTTInterceptor>
  - isProtocol
```
public boolean isProtocol(byte[] array)
```
    The protocol handler passes us an 8 byte long array from the transport. We sniff these first 8 bytes to see if they match the first 8 bytes from MQTT Connect packet. In many other protocols the protocol name is the first thing sent on the wire. However, in MQTT the protocol name doesn't come until later on in the CONNECT packet. In order to fully identify MQTT protocol via protocol name, we need up to 12 bytes. However, we can use other information from the connect packet to infer that the MQTT protocol is being used. This is enough to identify MQTT and add the Netty codec in the pipeline. The Netty codec takes care of things from here. MQTT CONNECT PACKET: See MQTT 3.1.1 Spec for more info. Byte 1: Fixed Header Packet Type. 0b0001000 (16) = MQTT Connect Byte 2-[N]: Remaining length of the Connect Packet (encoded with 1-4 bytes). The next set of bytes represents the UTF8 encoded string MQTT (MQTT 3.1.1) or MQIsdp (MQTT 3.1) Byte N: UTF8 MSB must be 0 Byte N+1: UTF8 LSB must be (4(MQTT) or 6(MQIsdp)) Byte N+1: M (first char from the protocol name). Max no bytes used in the sequence = 8.
    
    Specified by:
    
    isProtocol in interface ProtocolManager<MQTTInterceptor>
  - handshake
```
public void handshake(org.apache.activemq.artemis.core.remoting.impl.netty.NettyServerConnection connection,
                      ActiveMQBuffer buffer)
```
    Specified by:
    
    handshake in interface ProtocolManager<MQTTInterceptor>
  - websocketSubprotocolIdentifiers
```
public List<String> websocketSubprotocolIdentifiers()
```
    Specified by:
    
    websocketSubprotocolIdentifiers in interface ProtocolManager<MQTTInterceptor>
  - invokeIncoming
```
public String invokeIncoming(io.netty.handler.codec.mqtt.MqttMessage mqttMessage,
                             MQTTConnection connection)
```
  - invokeOutgoing
```
public String invokeOutgoing(io.netty.handler.codec.mqtt.MqttMessage mqttMessage,
                             MQTTConnection connection)
```
  - isClientConnected
```
public boolean isClientConnected(String clientId,
                                 MQTTConnection connection)
```
  - removeConnectedClient
```
public void removeConnectedClient(String clientId)
```
  - addConnectedClient
```
public MQTTConnection addConnectedClient(String clientId,
                                         MQTTConnection connection)
```
    Parameters:
    
    clientId -
    
    connection -
    
    Returns:
    
    the MQTTConnection that the added connection replaced or null if there was no previous entry for the clientId
  - getSessionState
```
public MQTTSessionState getSessionState(String clientId)
```
  - removeSessionState
```
public MQTTSessionState removeSessionState(String clientId)
```
  - getSessionStates
```
public Map<String,MQTTSessionState> getSessionStates()
```
  - getConnectedClients
```
public Map<String,MQTTConnection> getConnectedClients()
```
    For DEBUG only

Class MQTTProtocolManager

Method Summary

Methods inherited from class org.apache.activemq.artemis.spi.core.protocol.AbstractProtocolManager

Methods inherited from class java.lang.Object

Method Detail

onNotification

getFactory

updateInterceptors

createConnectionEntry

acceptsNoHandshake

removeHandler

handleBuffer

addChannelHandlers

isProtocol

handshake

websocketSubprotocolIdentifiers

invokeIncoming

invokeOutgoing

isClientConnected

removeConnectedClient

addConnectedClient

getSessionState

removeSessionState

getSessionStates

getConnectedClients