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

Class HTTPTransportHandler

java.lang.Object

org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.advanced.transport.http.HTTPTransportHandler

All Implemented Interfaces:

TransportHandler

Direct Known Subclasses:

FireAlarmHTTPCommunicator

public abstract class HTTPTransportHandler
extends Object
implements TransportHandler

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).

Field Summary

Fields

Modifier and Type	Field and Description
protected int	port
protected org.eclipse.jetty.server.Server	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	HTTPTransportHandler()
protected	HTTPTransportHandler(int port)
protected	HTTPTransportHandler(int port, int timeoutInterval)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection() Shuts-down the HTTP Server.
protected void	incrementPort()
boolean	isConnected() Checks whether the HTTP server is up and listening for incoming requests.
void	setTimeoutInterval(int timeoutInterval)

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 org.eclipse.jetty.server.Server server

port

protected int port

timeoutInterval

protected int timeoutInterval

Constructor Detail

HTTPTransportHandler

protected HTTPTransportHandler()

HTTPTransportHandler

protected HTTPTransportHandler(int port)

HTTPTransportHandler

protected HTTPTransportHandler(int port,
                    int timeoutInterval)

Method Detail

setTimeoutInterval

public void setTimeoutInterval(int timeoutInterval)

isConnected

public boolean isConnected()

Checks whether the HTTP server is up and listening for incoming requests.

Specified by:

isConnected in interface TransportHandler

Returns:

true if the server is up & listening for requests, else false.

incrementPort

protected void incrementPort()

closeConnection

public void closeConnection()
                     throws Exception

Shuts-down the HTTP Server.

Throws:

Exception