Share via

ProvisioningDeviceClientContract Class

  • Reference
Package:
com.microsoft.azure.sdk.iot.provisioning.device.internal.contract
  • java.lang.Object
    • com.microsoft.azure.sdk.iot.provisioning.device.internal.contract.ProvisioningDeviceClientContract

public class ProvisioningDeviceClientContract

Field Summary

Modifier and Type Field and Description
final String RETRY_AFTER

Method Summary

Modifier and Type Method and Description
abstract void authenticateWithProvisioningService(RequestData requestData, ResponseCallback responseCallback, Object dpsAuthorizationCallbackContext)
abstract void close()
ProvisioningDeviceClientContract createProvisioningContract(ProvisioningDeviceClientConfig provisioningDeviceClientConfig)

Static method to create contracts with the service over the specified protocol

abstract String getConnectionId()
abstract String getHostName()
abstract void getRegistrationStatus(RequestData requestData, ResponseCallback responseCallback, Object dpsAuthorizationCallbackContext)
int getRetryValue()

Method to get the DPS retry after value

abstract void open(RequestData requestData)
abstract void requestNonceForTPM(RequestData requestData, ResponseCallback responseCallback, Object dpsAuthorizationCallbackContext)
void setRetrieveRetryAfterValue(String protocolRetryValue)

Field Details

RETRY_AFTER

protected static final String RETRY_AFTER= "retry-after"

Method Details

authenticateWithProvisioningService

public abstract void authenticateWithProvisioningService(RequestData requestData, ResponseCallback responseCallback, Object dpsAuthorizationCallbackContext)

Parameters:

requestData
responseCallback
dpsAuthorizationCallbackContext

close

public abstract void close()

createProvisioningContract

public static ProvisioningDeviceClientContract createProvisioningContract(ProvisioningDeviceClientConfig provisioningDeviceClientConfig)

Static method to create contracts with the service over the specified protocol

Parameters:

provisioningDeviceClientConfig - Config used for provisioning

Returns:

Implementation of the relevant contract for the requested protocol

Throws:

ProvisioningDeviceClientException - This exception is thrown if the contract implementation could not be instantiated.

getConnectionId

public abstract String getConnectionId()

getHostName

public abstract String getHostName()

getRegistrationStatus

public abstract void getRegistrationStatus(RequestData requestData, ResponseCallback responseCallback, Object dpsAuthorizationCallbackContext)

Parameters:

requestData
responseCallback
dpsAuthorizationCallbackContext

getRetryValue

public int getRetryValue()

Method to get the DPS retry after value

Returns:

integer value of the number of milliseconds to wait to call dps service

open

public abstract void open(RequestData requestData)

Parameters:

requestData

requestNonceForTPM

public abstract void requestNonceForTPM(RequestData requestData, ResponseCallback responseCallback, Object dpsAuthorizationCallbackContext)

Parameters:

requestData
responseCallback
dpsAuthorizationCallbackContext

setRetrieveRetryAfterValue

protected void setRetrieveRetryAfterValue(String protocolRetryValue)

Parameters:

protocolRetryValue

Applies to