com.microsoft.azure.sdk.iot.service

Class ServiceClient

java.lang.Object

com.microsoft.azure.sdk.iot.service.ServiceClient

public class ServiceClient
extends Object

Extend the ServiceClient class and provide AMPQ specific implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected IotHubConnectionString	iotHubConnectionString

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceClient(IotHubConnectionString iotHubConnectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol) Initialize AMQP sender using given connection string
protected	ServiceClient(IotHubConnectionString iotHubConnectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol, ServiceClientOptions options) Initialize AMQP sender using given connection string

Method Summary

Modifier and Type	Method and Description
void	close() Close AMQP sender
CompletableFuture<Void>	closeAsync() Provide asynchronous access to close()
static ServiceClient	createFromConnectionString(String connectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol) Create ServiceClient from the specified connection string
static ServiceClient	createFromConnectionString(String connectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol, ServiceClientOptions options) Create ServiceClient from the specified connection string
FeedbackReceiver	getFeedbackReceiver() Instantiate a new FeedbackReceiver object.
FeedbackReceiver	getFeedbackReceiver(String deviceId) Deprecated. As of release 1.1.15, replaced by getFeedbackReceiver()
FileUploadNotificationReceiver	getFileUploadNotificationReceiver() Instantiate a new FileUploadNotificationReceiver object.
void	open() Open AMQP sender
CompletableFuture<Void>	openAsync() Provide asynchronous access to open()
void	send(String deviceId, Message message) Send a one-way message to the specified device.
void	send(String deviceId, String moduleId, Message message) Send a one-way message to the specified module.
CompletableFuture<Void>	sendAsync(String deviceId, Message message) Provide asynchronous access to send()

Methods inherited from class java.lang.Object

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

Field Detail

iotHubConnectionString

protected IotHubConnectionString iotHubConnectionString

Constructor Detail

ServiceClient

protected ServiceClient(IotHubConnectionString iotHubConnectionString,
                        IotHubServiceClientProtocol iotHubServiceClientProtocol)

Initialize AMQP sender using given connection string

Parameters:

iotHubConnectionString - The ConnectionString object for the IotHub

iotHubServiceClientProtocol - protocol to use

ServiceClient

protected ServiceClient(IotHubConnectionString iotHubConnectionString,
                        IotHubServiceClientProtocol iotHubServiceClientProtocol,
                        ServiceClientOptions options)

Initialize AMQP sender using given connection string

Parameters:

iotHubConnectionString - The ConnectionString object for the IotHub

iotHubServiceClientProtocol - protocol to use

options - options for proxy

Method Detail

createFromConnectionString

public static ServiceClient createFromConnectionString(String connectionString,
                                                       IotHubServiceClientProtocol iotHubServiceClientProtocol)
                                                throws IOException

Create ServiceClient from the specified connection string

Parameters:

iotHubServiceClientProtocol - protocol to use

connectionString - The connection string for the IotHub

Returns:

The created ServiceClient object

Throws:

IOException - This exception is thrown if the object creation failed

createFromConnectionString

public static ServiceClient createFromConnectionString(String connectionString,
                                                       IotHubServiceClientProtocol iotHubServiceClientProtocol,
                                                       ServiceClientOptions options)
                                                throws IOException

Create ServiceClient from the specified connection string

Parameters:

iotHubServiceClientProtocol - protocol to use

connectionString - The connection string for the IotHub

options - The connection options to use when connecting to the service. May be null if no custom options will be used.

Returns:

The created ServiceClient object

Throws:

IOException - This exception is thrown if the object creation failed

open

public void open()
          throws IOException

Open AMQP sender

Throws:

IOException - This exception is thrown if the AmqpSender object is not initialized

close

public void close()
           throws IOException

Close AMQP sender

Throws:

IOException - This exception is thrown if the AmqpSender object is not initialized

send

public void send(String deviceId,
                 Message message)
          throws IOException,
                 IotHubException

Send a one-way message to the specified device. This function is synchronized internally so that only one send operation is allowed at a time. In order to do more send operations at a time, you will need to instantiate another service client instance.

Parameters:

deviceId - The device identifier for the target device

message - The message for the device

Throws:

IOException - This exception is thrown if the AmqpSender object is not initialized

IotHubException - This exception is thrown if IotHub rejects the message for any reason

send

public void send(String deviceId,
                 String moduleId,
                 Message message)
          throws IOException,
                 IotHubException

Send a one-way message to the specified module. This function is synchronized internally so that only one send operation is allowed at a time. In order to do more send operations at a time, you will need to instantiate another service client instance.

Parameters:

deviceId - The device identifier for the target device

moduleId - The module identifier for the target device

message - The message for the device

Throws:

IOException - This exception is thrown if the AmqpSender object is not initialized

IotHubException - This exception is thrown if IotHub rejects the message for any reason

openAsync

public CompletableFuture<Void> openAsync()

Provide asynchronous access to open()

Returns:

The future object for the requested operation

closeAsync

public CompletableFuture<Void> closeAsync()

Provide asynchronous access to close()

Returns:

The future object for the requested operation

sendAsync

public CompletableFuture<Void> sendAsync(String deviceId,
                                         Message message)

Provide asynchronous access to send()

Parameters:

deviceId - The device identifier for the target device

message - The message for the device

Returns:

The future object for the requested operation

getFeedbackReceiver

@Deprecated
public FeedbackReceiver getFeedbackReceiver(String deviceId)

Deprecated. As of release 1.1.15, replaced by getFeedbackReceiver()

Get FeedbackReceiver object.This API has been deprecated. Use new API without deviceId as an input parameter.

Parameters:

deviceId - The device identifier for the target device

Returns:

The instance of the FeedbackReceiver

getFeedbackReceiver

public FeedbackReceiver getFeedbackReceiver()

Instantiate a new FeedbackReceiver object.

Returns:

The instance of the FeedbackReceiver

getFileUploadNotificationReceiver

public FileUploadNotificationReceiver getFileUploadNotificationReceiver()

Instantiate a new FileUploadNotificationReceiver object.

Returns:

The instance of the FileUploadNotificationReceiver