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

Class MultiplexingClientRegistrationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

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

All Implemented Interfaces:

java.io.Serializable

public class MultiplexingClientRegistrationException
extends IotHubClientException

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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRegistrationException(java.lang.String deviceId, java.lang.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(java.util.Map<java.lang.String,java.lang.Exception> registrationExceptions) Sets the full registrations exception map.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException()

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

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException(java.lang.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(java.lang.String message,
                                               java.lang.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.

MultiplexingClientRegistrationException

public MultiplexingClientRegistrationException(java.lang.Exception cause)

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

Parameters:

cause - The nested exception.

Method Detail

addRegistrationException

public void addRegistrationException(java.lang.String deviceId,
                                     java.lang.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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Exception> registrationExceptions)

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

Parameters:

registrationExceptions - the new full registrations exception map.