com.aylanetworks.aylasdk.lan

Class AylaLanMessage

java.lang.Object

com.aylanetworks.aylasdk.lan.AylaLanMessage

public class AylaLanMessage
extends java.lang.Object

Represents a message to or from the LAN-connected device. The AylaLanMessage has two fields, enc and sign. enc is an encrypted payload; sign is the signature. Both are Base64-encoded strings.

The getPayload(AylaEncryption) method can be used to decrypt and verify a received encrypted message.

The static fromSession(NanoHTTPD.IHTTPSession, AylaDevice) method can be used to construct an AylaLanMessage object from an HTTP session. This is used by AylaLanModule when processing incoming messages for property updates or commands from the module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AylaLanMessage.Payload

Constructor Summary

Constructors

Constructor and Description
AylaLanMessage()

Method Summary

Modifier and Type	Method and Description
static AylaLanMessage	fromSession(fi.iki.elonen.NanoHTTPD.IHTTPSession session, AylaDevice device) Creates an AylaLanMessage object from an HTTP session.
AylaLanMessage.Payload	getPayload(com.aylanetworks.aylasdk.lan.AylaEncryption encryption) Returns the decrypted message portion of the LanMessage object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AylaLanMessage

public AylaLanMessage()

Method Detail

fromSession

public static AylaLanMessage fromSession(fi.iki.elonen.NanoHTTPD.IHTTPSession session,
                                         AylaDevice device)
                                  throws PreconditionError,
                                         InternalError

Creates an AylaLanMessage object from an HTTP session. This is used by AylaLanModule when processing incoming commands from the device in LAN mode.

Parameters:

session - HTTP session containing the message data

device - Device this message is intended for

Returns:

an AylaLanMessage initialized with the data found in the HTTP session

Throws:

PreconditionError - if the device is not in LAN mode,

InternalError - if no data is found in the HTTP session input stream

getPayload

public AylaLanMessage.Payload getPayload(com.aylanetworks.aylasdk.lan.AylaEncryption encryption)
                                  throws AylaError

Returns the decrypted message portion of the LanMessage object. If any errors are encountered while processing, an AylaError will be thrown.

Parameters:

encryption - AylaEncryption object used to perform the decryption

Returns:

The decrypted message payload

Throws:

AylaError - if an error occurred. Errors can include:

• PreconditionError if the message recipient could not be found or the device is not running a LAN session (no LAN module exists)
• InvalidArgumentError if the encryption parameter is null or the message could not be decrypted or if the signature did not match