org.astarteplatform.devicesdk.protocol

Class AstarteInterface

java.lang.Object

org.astarteplatform.devicesdk.protocol.AstarteInterface

Direct Known Subclasses:

AstarteDatastreamInterface, AstartePropertyInterface

public abstract class AstarteInterface
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AstarteInterface()

Method Summary

Modifier and Type	Method and Description
static AstarteInterfaceMapping	findMappingInInterface(AstarteInterface astarteInterface, java.lang.String path)
static AstarteInterface	fromJSON(org.json.JSONObject astarteInterfaceObject, AstartePropertyStorage propertyStorage)
AstarteTransport	getAstarteTransport()
java.lang.String	getInterfaceName()
int	getMajorVersion()
java.util.Map<java.lang.String,AstarteInterfaceMapping>	getMappings()
int	getMinorVersion()
static boolean	isPathCompatibleWithMapping(java.lang.String path, java.lang.String mapping)
void	setAstarteTransport(AstarteTransport astarteTransport)
static void	validateAggregate(AstarteInterface astarteInterface, java.lang.String pathPrefix, java.util.Map<java.lang.String,java.lang.Object> payload, org.joda.time.DateTime timestamp)
static void	validatePayload(AstarteInterfaceMapping mapping, java.lang.Object payload)
static void	validatePayload(AstarteInterfaceMapping mapping, java.lang.Object payload, org.joda.time.DateTime timestamp)
static void	validatePayload(AstarteInterface astarteInterface, java.lang.String path, java.lang.Object payload)
static void	validatePayload(AstarteInterface astarteInterface, java.lang.String path, java.lang.Object payload, org.joda.time.DateTime timestamp)

Methods inherited from class java.lang.Object

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

Constructor Detail

AstarteInterface

public AstarteInterface()

Method Detail

getAstarteTransport

public AstarteTransport getAstarteTransport()

setAstarteTransport

public void setAstarteTransport(AstarteTransport astarteTransport)

fromJSON

public static AstarteInterface fromJSON(org.json.JSONObject astarteInterfaceObject,
                                        AstartePropertyStorage propertyStorage)
                                 throws org.json.JSONException,
                                        AstarteInvalidInterfaceException

Throws:

org.json.JSONException

AstarteInvalidInterfaceException

findMappingInInterface

public static AstarteInterfaceMapping findMappingInInterface(AstarteInterface astarteInterface,
                                                             java.lang.String path)
                                                      throws AstarteInterfaceMappingNotFoundException

Throws:

AstarteInterfaceMappingNotFoundException

validatePayload

public static void validatePayload(AstarteInterface astarteInterface,
                                   java.lang.String path,
                                   java.lang.Object payload)
                            throws AstarteInvalidValueException,
                                   AstarteInterfaceMappingNotFoundException

Throws:

AstarteInvalidValueException

AstarteInterfaceMappingNotFoundException

validatePayload

public static void validatePayload(AstarteInterface astarteInterface,
                                   java.lang.String path,
                                   java.lang.Object payload,
                                   org.joda.time.DateTime timestamp)
                            throws AstarteInvalidValueException,
                                   AstarteInterfaceMappingNotFoundException

Throws:

AstarteInvalidValueException

AstarteInterfaceMappingNotFoundException

validatePayload

public static void validatePayload(AstarteInterfaceMapping mapping,
                                   java.lang.Object payload)
                            throws AstarteInvalidValueException

Throws:

AstarteInvalidValueException

validatePayload

public static void validatePayload(AstarteInterfaceMapping mapping,
                                   java.lang.Object payload,
                                   org.joda.time.DateTime timestamp)
                            throws AstarteInvalidValueException

Throws:

AstarteInvalidValueException

validateAggregate

public static void validateAggregate(AstarteInterface astarteInterface,
                                     java.lang.String pathPrefix,
                                     java.util.Map<java.lang.String,java.lang.Object> payload,
                                     org.joda.time.DateTime timestamp)
                              throws AstarteInvalidValueException,
                                     AstarteInterfaceMappingNotFoundException

Throws:

AstarteInvalidValueException

AstarteInterfaceMappingNotFoundException

isPathCompatibleWithMapping

public static boolean isPathCompatibleWithMapping(java.lang.String path,
                                                  java.lang.String mapping)

getInterfaceName

public java.lang.String getInterfaceName()

getMajorVersion

public int getMajorVersion()

getMinorVersion

public int getMinorVersion()

getMappings

public java.util.Map<java.lang.String,AstarteInterfaceMapping> getMappings()