org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.advanced.transport.xmpp

Class XMPPTransportHandler

java.lang.Object

org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.advanced.transport.xmpp.XMPPTransportHandler

All Implemented Interfaces:

TransportHandler<org.jivesoftware.smack.packet.Message>

Direct Known Subclasses:

FireAlarmXMPPCommunicator

public abstract class XMPPTransportHandler
extends Object
implements TransportHandler<org.jivesoftware.smack.packet.Message>

This is an abstract class that implements the "TransportHandler" interface. The interface is an abstraction for the core functionality with regards to device-server communication regardless of the Transport protocol. This specific class contains the HTTP-Transport specific implementations. The class implements utility methods for the case of a HTTP communication. However, this "abstract class", even-though it implements the "TransportHandler" interface, does not contain the logic relevant to the interface methods. The specific functionality of the interface methods are intended to be implemented by the concrete class that extends this abstract class and utilizes the HTTP specific functionality (ideally a device API writer who would like to communicate to the device via HTTP Protocol).

This class contains the IoT-Server specific implementation for all the XMPP functionality. This includes connecting to a XMPP Server & Login-In using the device's/server's XMPP-Account, Setting listeners and filters on incoming XMPP messages and Sending XMPP replies for messages received. Makes use of the 'Smack-XMPP' library provided by jivesoftware/igniterealtime.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	server
protected int	timeoutInterval

Fields inherited from interface org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.advanced.transport.TransportHandler

DEFAULT_TIMEOUT_INTERVAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMPPTransportHandler(String server) Constructor for XMPPTransportHandler passing only the server-IP.
protected	XMPPTransportHandler(String server, int port) Constructor for XMPPTransportHandler passing server-IP and the XMPP-port.
protected	XMPPTransportHandler(String server, int port, int timeoutInterval) Constructor for XMPPTransportHandler passing server-IP, the XMPP-port and the timeoutInterval used by listeners to the server and for reconnection schedules.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection() Closes the connection to the XMPP Server.
protected void	connectToServer() Connects to the XMPP-Server and if attempt unsuccessful, then throws exception.
protected void	disableDebugger() Disables default debugger provided by the XMPPConnection.
boolean	isConnected() Checks whether the connection to the XMPP-Server persists.
protected void	loginToServer(String username, String password, String resource) If successfully established connection, then tries to Log in using the device's XMPP Account credentials.
protected void	sendXMPPMessage(String JID, org.jivesoftware.smack.packet.Message xmppMessage) Sends an XMPP message.
protected void	sendXMPPMessage(String JID, String message) Sends an XMPP message.
protected void	sendXMPPMessage(String JID, String message, String subject) Overloaded method to send an XMPP message.
protected void	setFilterOnReceiver(String receiverJID) Sets a filter for all the incoming XMPP-Messages on the Receiver's JID (XMPP-Account ID).
protected void	setFilterOnSender(String senderJID) Sets a filter for all the incoming XMPP-Messages on the Sender's JID (XMPP-Account ID).
protected void	setMessageFilterAndListener(String senderJID, String receiverJID, boolean andCondition) Sets a filter for all the incoming XMPP-Messages on the From-JID & To-JID (XMPP-Account IDs) passed in.
void	setTimeoutInterval(int millis) Sets the client's time-out-limit whilst waiting for XMPP-replies from server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.advanced.transport.TransportHandler

connect, disconnect, processIncomingMessage, processIncomingMessage, publishDeviceData, publishDeviceData

Field Detail

server

protected String server

timeoutInterval

protected int timeoutInterval

Constructor Detail

XMPPTransportHandler

protected XMPPTransportHandler(String server)

Constructor for XMPPTransportHandler passing only the server-IP.

Parameters:

server - the IP of the XMPP server.

XMPPTransportHandler

protected XMPPTransportHandler(String server,
                    int port)

Constructor for XMPPTransportHandler passing server-IP and the XMPP-port.

Parameters:

server - the IP of the XMPP server.

port - the XMPP server's port to connect to. (default - 5222)

XMPPTransportHandler

protected XMPPTransportHandler(String server,
                    int port,
                    int timeoutInterval)

Constructor for XMPPTransportHandler passing server-IP, the XMPP-port and the timeoutInterval used by listeners to the server and for reconnection schedules.

Parameters:

server - the IP of the XMPP server.

port - the XMPP server's port to connect to. (default - 5222)

timeoutInterval - the timeout interval to use for the connection and reconnection

Method Detail

setTimeoutInterval

public void setTimeoutInterval(int millis)

Sets the client's time-out-limit whilst waiting for XMPP-replies from server.

Parameters:

millis - the time in millis to be set as the time-out-limit whilst waiting for a XMPP-reply.

isConnected

public boolean isConnected()

Checks whether the connection to the XMPP-Server persists.

Specified by:

isConnected in interface TransportHandler<org.jivesoftware.smack.packet.Message>

Returns:

true if the client is connected to the XMPP-Server, else false.

connectToServer

protected void connectToServer()
                        throws TransportHandlerException

Connects to the XMPP-Server and if attempt unsuccessful, then throws exception.

Throws:

TransportHandlerException - in the event of 'Connecting to' the XMPP server fails.

loginToServer

protected void loginToServer(String username,
                 String password,
                 String resource)
                      throws TransportHandlerException

If successfully established connection, then tries to Log in using the device's XMPP Account credentials.

Parameters:

username - the username of the device's XMPP-Account.

password - the password of the device's XMPP-Account.

resource - the resource the resource, specific to the XMPP-Account to which the login is made to

Throws:

TransportHandlerException - in the event of 'Logging into' the XMPP server fails.

setFilterOnSender

protected void setFilterOnSender(String senderJID)

Sets a filter for all the incoming XMPP-Messages on the Sender's JID (XMPP-Account ID). Also creates a listener for the incoming messages and connects the listener to the XMPPConnection alongside the set filter.

Parameters:

senderJID - the JID (XMPP-Account ID of the sender) to which the filter is to be set.

setFilterOnReceiver

protected void setFilterOnReceiver(String receiverJID)

Sets a filter for all the incoming XMPP-Messages on the Receiver's JID (XMPP-Account ID). Also creates a listener for the incoming messages and connects the listener to the XMPPConnection alongside the set filter.

Parameters:

receiverJID - the JID (XMPP-Account ID of the receiver) to which the filter is to be set.

setMessageFilterAndListener

protected void setMessageFilterAndListener(String senderJID,
                               String receiverJID,
                               boolean andCondition)

Sets a filter for all the incoming XMPP-Messages on the From-JID & To-JID (XMPP-Account IDs) passed in. Also creates a listener for the incoming messages and connects the listener to the XMPPConnection alongside the set filter.

Parameters:

senderJID - the From-JID (XMPP-Account ID) to which the filter is to be set.

receiverJID - the To-JID (XMPP-Account ID) to which the filter is to be set.

andCondition - if true: then filter is set with 'AND' operator (senderJID && receiverJID), if false: then the filter is set with 'OR' operator (senderJID | receiverJID)

sendXMPPMessage

protected void sendXMPPMessage(String JID,
                   String message)

Sends an XMPP message. Calls the overloaded method with Subject set to "Reply-From-Device"

Parameters:

JID - the JID (XMPP Account ID) to which the message is to be sent to.

message - the XMPP-Message that is to be sent.

sendXMPPMessage

protected void sendXMPPMessage(String JID,
                   String message,
                   String subject)

Overloaded method to send an XMPP message. Includes the subject to be mentioned in the message that is sent.

Parameters:

JID - the JID (XMPP Account ID) to which the message is to be sent to.

message - the XMPP-Message that is to be sent.

subject - the subject that the XMPP-Message would carry.

sendXMPPMessage

protected void sendXMPPMessage(String JID,
                   org.jivesoftware.smack.packet.Message xmppMessage)

Sends an XMPP message.

Parameters:

JID - the JID (XMPP Account ID) to which the message is to be sent to.

xmppMessage - the XMPP-Message that is to be sent.

disableDebugger

protected void disableDebugger()

Disables default debugger provided by the XMPPConnection.

closeConnection

public void closeConnection()

Closes the connection to the XMPP Server.