com.alexscottrhodes.rest

Class Insecure

java.lang.Object

com.alexscottrhodes.rest.Insecure

public class Insecure
extends java.lang.Object

The main endpoint for devices connecting to the IoT network for devices using GET parameters to pass data. The REST calls here do not require any type of authentication.

Author:

Alex Rhodes

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gson.Gson	gson

Constructor Summary

Constructors

Constructor and Description
Insecure()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	insecure() A utility URL that returns a 200 response when the webservice is up and running.
javax.ws.rs.core.Response	registerDevice(java.lang.String name, java.lang.String ipAddress) Method for devices to register their IP address with the service when first establishing a connection to the network.
javax.ws.rs.core.Response	sendCommand(java.lang.String deviceName, java.lang.String commandName, java.lang.String commandValue) Method for sending a command to a device.
javax.ws.rs.core.Response	sendMail(java.lang.String deviceName, java.lang.String message) Method providing email functionality to IoT Devices
javax.ws.rs.core.Response	sendMailWithAddress(java.lang.String toEmail, java.lang.String deviceName, java.lang.String message)

Methods inherited from class java.lang.Object

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

Field Detail

gson

private com.google.gson.Gson gson

Constructor Detail

Insecure

public Insecure()

Method Detail

insecure

public javax.ws.rs.core.Response insecure()

A utility URL that returns a 200 response when the webservice is up and running.

Returns:

a Response of 200 indicating the web service is available

registerDevice

public javax.ws.rs.core.Response registerDevice(java.lang.String name,
                                                java.lang.String ipAddress)

Method for devices to register their IP address with the service when first establishing a connection to the network.

Parameters:

name - a String representing the permanent name of the device that other devices on the network use when targeting it

ipAddress - a String of the device's IP address on the IoT network

Returns:

an HTTP Response indicating success or failure of the decvice's registration.

sendCommand

public javax.ws.rs.core.Response sendCommand(java.lang.String deviceName,
                                             java.lang.String commandName,
                                             java.lang.String commandValue)

Method for sending a command to a device. The target device, command name and value are passed. The commands are stored in the database. Commands are then sent to the target device. If the device can not be reached, the commands are stored. If they device provides a response, this response and the response code is passed to the sending device.

Parameters:

deviceName - the Device identifier for the target device

commandName - the Command identifier for the command being sent

commandValue - the Command value to send

Returns:

a Response with an HttpTransaction object in JSON format providing successful and failed transaction information and device responses to the command.

sendMail

public javax.ws.rs.core.Response sendMail(java.lang.String deviceName,
                                          java.lang.String message)

Method providing email functionality to IoT Devices

Parameters:

deviceName - a String representing the name of the device sending the message

message - a String of the message to be sent

Returns:

a Response indicating success or failure of the sent message.

sendMailWithAddress

public javax.ws.rs.core.Response sendMailWithAddress(java.lang.String toEmail,
                                                     java.lang.String deviceName,
                                                     java.lang.String message)