MultiplexingClientDeviceRegistrationAuthenticationException Class

Package:

com.microsoft.azure.sdk.iot.device.exceptions

Maven Artifact:

com.microsoft.azure.sdk.iot:iot-device-client:1.30.1

• java.lang.Object
• • java.lang.Throwable
  • • java.lang.Exception
    • • com.microsoft.azure.sdk.iot.device.exceptions.MultiplexingClientException
      • • com.microsoft.azure.sdk.iot.device.exceptions.MultiplexingClientDeviceRegistrationAuthenticationException

public class MultiplexingClientDeviceRegistrationAuthenticationException
extends MultiplexingClientException

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

Constructor Summary

Constructor	Description
MultiplexingClientDeviceRegistrationAuthenticationException()	Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception and no error message.
MultiplexingClientDeviceRegistrationAuthenticationException(String message)	Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception but with an error message.
MultiplexingClientDeviceRegistrationAuthenticationException(String message, Throwable cause)	Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception and an error message.
MultiplexingClientDeviceRegistrationAuthenticationException(Throwable cause)	Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception but no error message.

Method Summary

Modifier and Type	Method and Description
void	addRegistrationException(String deviceId, Exception registrationException) Associate a new registration exception to a device.
java.util.Map<java.lang.String,java.lang.Exception>	getRegistrationExceptions() Get the exception for each device that failed to register.
void	setRegistrationExceptionsMap(Map<String,Exception> registrationExceptions) Sets the full registrations exception map.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Methods inherited from java.lang.Throwable

java.lang.Throwable.addSuppressed java.lang.Throwable.fillInStackTrace java.lang.Throwable.getCause java.lang.Throwable.getLocalizedMessage java.lang.Throwable.getMessage java.lang.Throwable.getStackTrace java.lang.Throwable.getSuppressed java.lang.Throwable.initCause java.lang.Throwable.printStackTrace java.lang.Throwable.printStackTrace java.lang.Throwable.printStackTrace java.lang.Throwable.setStackTrace java.lang.Throwable.toString

Constructor Details

MultiplexingClientDeviceRegistrationAuthenticationException

public MultiplexingClientDeviceRegistrationAuthenticationException()

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

MultiplexingClientDeviceRegistrationAuthenticationException

public MultiplexingClientDeviceRegistrationAuthenticationException(String message)

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

Parameters:

message - The top level message for this exception.

MultiplexingClientDeviceRegistrationAuthenticationException

public MultiplexingClientDeviceRegistrationAuthenticationException(String message, Throwable 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.

MultiplexingClientDeviceRegistrationAuthenticationException

public MultiplexingClientDeviceRegistrationAuthenticationException(Throwable cause)

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

Parameters:

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<String,Exception> 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<String,Exception> registrationExceptions)

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

Parameters:

registrationExceptions - the new full registrations exception map.