Package com.github.lucadruda.iotc.device

Class IoTCClient

java.lang.Object

com.github.lucadruda.iotc.device.IoTCClient

All Implemented Interfaces:

IIoTCClient

public class IoTCClient
extends Object
implements IIoTCClient

Constructor Summary

Constructors

Constructor	Description
IoTCClient(String deviceId, String scopeId, IOTC_CONNECT authenticationType, Object options, ICentralStorage storage)
IoTCClient(String deviceId, String scopeId, IOTC_CONNECT authenticationType, Object options, ICentralStorage storage, ILogger logger)

Method Summary

Modifier and Type	Method	Description
void	Connect()	Connect the device
void	Connect(Integer timeout)	Connect the device
void	Disconnect()	Disconnect device.
void	FetchTwin()
IOTC_CONNECT	getAuthenticationType()
X509Certificate	getCertificate()
com.microsoft.azure.sdk.iot.device.DeviceClient	getDeviceClient()
String	getDeviceId()
ILogger	getLogger()
String	getModelId()	Returns the model Id
com.microsoft.azure.sdk.iot.device.IotHubClientProtocol	getProtocol()
String	getSasKey()
String	getScopeId()
boolean	IsConnected()
void	on(IOTC_EVENTS event, IoTCCallback callback)
void	SendProperty(Object payload)
void	SendProperty(String payload)
void	SendTelemetry(Object payload)
void	SendTelemetry(Object payload, Object properties)
void	SendTelemetry(Object payload, String properties)
void	SendTelemetry(String payload)
void	SendTelemetry(String payload, Object properties)
void	SendTelemetry(String payload, String properties)
void	SetConnectionState(boolean state)
void	SetGlobalEndpoint(String endpoint)	Set global endpoint for DPS provisioning
void	SetLogging(IOTC_LOGGING logLevel)
void	SetModelId(String modelId)	Set the model Id
void	SetProtocol(IOTC_PROTOCOL transport)
boolean	UploadFile(String fileName, File file)
boolean	UploadFile(String fileName, File file, String encoding)

Methods inherited from class java.lang.Object

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

Constructor Details

IoTCClient

public IoTCClient(String deviceId,
 String scopeId,
 IOTC_CONNECT authenticationType,
 Object options,
 ICentralStorage storage,
 ILogger logger)

Parameters:

deviceId - The device Id

scopeId - Scope Id of the application

authenticationType - Type of authentication: It can be Group symmetric key, Device SAS key or x.509

options - Value for authentication: keys for symmetric and SAS key authentication or x.509 certificate

storage - An ICentralStorage implementation to cache device credentials

logger - A custom logger implementing the ILogger interface

IoTCClient

public IoTCClient(String deviceId,
 String scopeId,
 IOTC_CONNECT authenticationType,
 Object options,
 ICentralStorage storage)

Method Details

getModelId

public String getModelId()

Returns the model Id

Returns:

the modelId

SetModelId

public void SetModelId(String modelId)

Set the model Id

Specified by:

SetModelId in interface IIoTCClient

Parameters:

modelId - IoT Central model Id for automatic approval process

SetLogging

public void SetLogging(IOTC_LOGGING logLevel)

Specified by:

SetLogging in interface IIoTCClient

Parameters:

logLevel - the logger to set

SetProtocol

public void SetProtocol(IOTC_PROTOCOL transport)

Specified by:

SetProtocol in interface IIoTCClient

SetGlobalEndpoint

public void SetGlobalEndpoint(String endpoint)

Description copied from interface: IIoTCClient

Set global endpoint for DPS provisioning

Specified by:

SetGlobalEndpoint in interface IIoTCClient

Parameters:

endpoint - hostname without protocol

Disconnect

public void Disconnect()
                throws IoTCentralException

Description copied from interface: IIoTCClient

Disconnect device. Client cannot be reused after disconnect!!!

Specified by:

Disconnect in interface IIoTCClient

Throws:

IoTCentralException - If disconnection fails

Connect

public void Connect()
             throws IoTCentralException

Description copied from interface: IIoTCClient

Connect the device

Specified by:

Connect in interface IIoTCClient

Throws:

IoTCentralException - If connection fails

Connect

public void Connect(Integer timeout)
             throws IoTCentralException

Description copied from interface: IIoTCClient

Connect the device

Specified by:

Connect in interface IIoTCClient

Parameters:

timeout - Timeout in seconds before forcing connection stop

Throws:

IoTCentralException - If connection fails

SendTelemetry

public void SendTelemetry(String payload)
                   throws IoTCentralException

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - Message to send: can be any type (usually json) or a collection of messages

Throws:

IoTCentralException - If telemetry delivery failed

SendTelemetry

public void SendTelemetry(Object payload)
                   throws IoTCentralException

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - Message to send: can be any type (usually json) or a collection of messages

Throws:

IoTCentralException - If telemetry delivery failed

SendTelemetry

public void SendTelemetry(Object payload,
 String properties)
                   throws IoTCentralException

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - Message to send: can be any type (usually json) or a collection of messages

properties - Properties to be added to the message (JSON format)

Throws:

IoTCentralException - If telemetry delivery failed

SendTelemetry

public void SendTelemetry(String payload,
 Object properties)
                   throws IoTCentralException

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - Message to send: can be any type (usually json) or a collection of messages

properties - Properties to be added to the message (JSON format)

Throws:

IoTCentralException - If telemetry delivery failed

SendTelemetry

public void SendTelemetry(Object payload,
 Object properties)
                   throws IoTCentralException

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - Message to send: can be any type (usually json) or a collection of messages

properties - Properties to be added to the message (JSON format)

Throws:

IoTCentralException - If telemetry delivery failed

SendTelemetry

public void SendTelemetry(String payload,
 String properties)
                   throws IoTCentralException

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - Message to send: can be any type (usually json) or a collection of messages

properties - Properties to be added to the message (JSON format)

Throws:

IoTCentralException - If telemetry delivery failed

SendProperty

public void SendProperty(String payload)
                  throws IoTCentralException

Specified by:

SendProperty in interface IIoTCClient

Parameters:

payload - Property to send: can be any type (usually json) or a collection of properties

Throws:

IoTCentralException - If property delivery fails

SendProperty

public void SendProperty(Object payload)
                  throws IoTCentralException

Specified by:

SendProperty in interface IIoTCClient

Parameters:

payload - Property to send: can be any type (usually json) or a collection of properties

Throws:

IoTCentralException - If property delivery fails

on

public void on(IOTC_EVENTS event,
 IoTCCallback callback)

Specified by:

on in interface IIoTCClient

Parameters:

event - name of the event to listen

callback - function to execute when event triggers

getLogger

public ILogger getLogger()

Returns:

the logger

getDeviceId

public String getDeviceId()

Returns:

the id

getScopeId

public String getScopeId()

Returns:

the scopeId

getAuthenticationType

public IOTC_CONNECT getAuthenticationType()

Returns:

the authenticationType

getSasKey

public String getSasKey()

Returns:

the sasKey

getCertificate

public X509Certificate getCertificate()

Returns:

the certificate

getProtocol

public com.microsoft.azure.sdk.iot.device.IotHubClientProtocol getProtocol()

Returns:

the protocol

getDeviceClient

public com.microsoft.azure.sdk.iot.device.DeviceClient getDeviceClient()

Returns:

the deviceClient

IsConnected

public boolean IsConnected()

Specified by:

IsConnected in interface IIoTCClient

SetConnectionState

public void SetConnectionState(boolean state)

FetchTwin

public void FetchTwin()
               throws IoTCentralException

Specified by:

FetchTwin in interface IIoTCClient

Throws:

IoTCentralException

UploadFile

public boolean UploadFile(String fileName,
 File file)
                   throws IoTCentralException

Specified by:

UploadFile in interface IIoTCClient

Throws:

IoTCentralException

UploadFile

public boolean UploadFile(String fileName,
 File file,
 String encoding)
                   throws IoTCentralException

Specified by:

UploadFile in interface IIoTCClient

Throws:

IoTCentralException