com.microsoft.azure.sdk.iot.provisioning.service

Class RegistrationStatusManager

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.service.RegistrationStatusManager

public class RegistrationStatusManager
extends Object

Registration Status Manager

This is the inner class that implements the Registration Status APIs.

For the exposed API, please see ProvisioningServiceClient.

See Also:

Azure IoT Hub Device Provisioning Service

Method Summary

Modifier and Type	Method and Description
Query	createEnrollmentGroupQuery(QuerySpecification querySpecification, String enrollmentGroupId, int pageSize) Create a new registration status query for enrollmentGroup.
static RegistrationStatusManager	createFromContractApiHttp(ContractApiHttp contractApiHttp) Create a new instance of the RegistrationStatusManager using the provided connection string and https as the transport protocol.
void	delete(DeviceRegistrationState DeviceRegistrationState) Delete registration status.
void	delete(String id, String eTag) Delete registration status.
DeviceRegistrationState	get(String id) Get device registration status information.

Methods inherited from class java.lang.Object

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

Method Detail

createFromContractApiHttp

public static RegistrationStatusManager createFromContractApiHttp(ContractApiHttp contractApiHttp)

Create a new instance of the RegistrationStatusManager using the provided connection string and https as the transport protocol.

Parameters:

contractApiHttp - is the class that cares the Http connection.

Returns:

The RegistrationStatusManager with the new instance of this class.

Throws:

IllegalArgumentException - if the ContractApiHttp is null.

get

public DeviceRegistrationState get(String id)
                            throws ProvisioningServiceClientException

Get device registration status information.

Parameters:

id - the String that identifies the registration status. It cannot be null or empty.

Returns:

An DeviceRegistrationState with the registration status information.

Throws:

IllegalArgumentException - if the provided parameter is not correct.

ProvisioningServiceClientTransportException - if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException - if the Device Provisioning Service was not able to execute the bulk operation.

See Also:

ProvisioningServiceClient.getDeviceRegistrationState(String)

delete

public void delete(DeviceRegistrationState DeviceRegistrationState)
            throws ProvisioningServiceClientException

Delete registration status.

Parameters:

DeviceRegistrationState - is a DeviceRegistrationState that describes the registration status that will be deleted. It cannot be null.

Throws:

IllegalArgumentException - if the provided parameter is not correct.

ProvisioningServiceClientTransportException - if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException - if the Device Provisioning Service was not able to execute the delete operation.

See Also:

ProvisioningServiceClient.deleteDeviceRegistrationStatus(DeviceRegistrationState)

delete

public void delete(String id,
                   String eTag)
            throws ProvisioningServiceClientException

Delete registration status.

Parameters:

id - is a String with the identification of the registration status to delete. It cannot be null or empty.

eTag - is a String with the eTag of the enrollment to delete. It can be null or empty (ignored).

Throws:

IllegalArgumentException - if the provided id is not correct.

ProvisioningServiceClientTransportException - if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException - if the Device Provisioning Service was not able to execute the bulk operation.

See Also:

ProvisioningServiceClient.deleteDeviceRegistrationStatus(String), ProvisioningServiceClient.deleteDeviceRegistrationStatus(String, String)

createEnrollmentGroupQuery

public Query createEnrollmentGroupQuery(QuerySpecification querySpecification,
                                        String enrollmentGroupId,
                                        int pageSize)

Create a new registration status query for enrollmentGroup.

Parameters:

querySpecification - is a String with the SQL query specification. It cannot be null.

enrollmentGroupId - is a String with the enrollmentGroupId of the enrollmentGroup to delete. It cannot be null or empty.

pageSize - the int with the maximum number of items per iteration. It can be 0 for default, but not negative.

Returns:

A Query iterator.

Throws:

IllegalArgumentException - if the provided parameter is not correct.

See Also:

ProvisioningServiceClient.createEnrollmentGroupRegistrationStatusQuery(QuerySpecification, String), ProvisioningServiceClient.createEnrollmentGroupRegistrationStatusQuery(QuerySpecification, String, int)