MultiplexingClientRegistrationException Class

  • Reference
Package:
com.microsoft.azure.sdk.iot.device.exceptions
  • java.lang.Object
    • Exception
      • IotHubClientException
        • com.microsoft.azure.sdk.iot.device.exceptions.MultiplexingClientRegistrationException

public class MultiplexingClientRegistrationException extends IotHubClientException

Exception that is thrown when one or more devices fail to register to an active multiplexed connection.

Constructor Summary

Constructor Description
MultiplexingClientRegistrationException()

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception and no error message.

MultiplexingClientRegistrationException(Exception cause)

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception but no error message.

MultiplexingClientRegistrationException(String message)

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception but with an error message.

MultiplexingClientRegistrationException(String message, Exception cause)

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception and an error message.

Method Summary

Modifier and Type Method and Description
void addRegistrationException(String deviceId, Exception registrationException)

Associate a new registration exception to a device.

Map<String, Exception> getRegistrationExceptions()

Get the exception for each device that failed to register.

void setRegistrationExceptionsMap(Map<String, Exception> registrationExceptions)

Sets the full registrations exception map. This will overwrite any previously saved mappings.

Inherited Members

IotHubClientException.IotHubClientException(IotHubStatusCode statusCode) IotHubClientException.IotHubClientException(IotHubStatusCode statusCode, String errorMessage) IotHubClientException.IotHubClientException(IotHubStatusCode statusCode, Exception nestedException) IotHubClientException.IotHubClientException(IotHubStatusCode statusCode, String errorMessage, Exception nestedException)

Constructor Details

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException()

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception and no error message.

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException(Exception cause)

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception but no error message.

Parameters:

cause - The nested exception.

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException(String message)

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception but with an error message.

Parameters:

message - The top level message for this exception.

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException(String message, Exception cause)

Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception and an error message.

Parameters:

message - The top level message for this exception.
cause - The nested exception.

Method Details

addRegistrationException

public void addRegistrationException(String deviceId, Exception registrationException)

Associate a new registration exception to a device.

Parameters:

deviceId - The device that failed to register to an active multiplexed connection.
registrationException - The exception that explains why the device failed to register to an active multiplexed connection.

getRegistrationExceptions

public Map getRegistrationExceptions()

Get the exception for each device that failed to register.

Returns:

A map containing the deviceId's that failed to register mapped to the exception that explains why they failed to register.

setRegistrationExceptionsMap

public void setRegistrationExceptionsMap(Map registrationExceptions)

Sets the full registrations exception map. This will overwrite any previously saved mappings.

Parameters:

registrationExceptions - the new full registrations exception map.

Applies to