com.microsoft.azure.sdk.iot.device.exceptions.MultiplexingClientRegistrationException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iot-device-client Show documentation
The Microsoft Azure IoT Device SDK for Java
There is a newer version: 2.5.0
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

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

import com.microsoft.azure.sdk.iot.device.IotHubStatusCode;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * Exception that is thrown when one or more devices fail to register to an active multiplexed connection.
 */
public class MultiplexingClientRegistrationException extends IotHubClientException
{
    private Map registrationExceptions = new HashMap<>();

    /**
     * Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception and no error message.
     */
    public MultiplexingClientRegistrationException()
    {
        super(IotHubStatusCode.ERROR);
    }

    /**
     * Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with no nested exception but with an error message.
     * @param message The top level message for this exception.
     */
    public MultiplexingClientRegistrationException(String message)
    {
        super(IotHubStatusCode.ERROR, message);
    }

    /**
     * Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception and an error message.
     * @param message The top level message for this exception.
     * @param cause The nested exception.
     */
    public MultiplexingClientRegistrationException(String message, Exception cause)
    {
        super(IotHubStatusCode.ERROR, message, cause);
    }

    /**
     * Construct a new MultiplexingClientDeviceRegistrationAuthenticationException with a nested exception but no error message.
     * @param cause The nested exception.
     */
    public MultiplexingClientRegistrationException(Exception cause)
    {
        super(IotHubStatusCode.ERROR, "", cause);
    }

    /**
     * Associate a new registration exception to a device.
     * @param deviceId The device that failed to register to an active multiplexed connection.
     * @param registrationException The exception that explains why the device failed to register to an active multiplexed connection.
     */
    public void addRegistrationException(String deviceId, Exception registrationException)
    {
        Objects.requireNonNull(registrationException, "registrationException cannot be null");
        if (deviceId == null || deviceId.isEmpty())
        {
            throw new IllegalArgumentException("DeviceId cannot be null or empty");
        }

        registrationExceptions.put(deviceId, registrationException);
    }

    /**
     * Get the exception for each device that failed to register.
     * @return A map containing the deviceId's that failed to register mapped to the exception that explains why they failed to register.
     */
    public Map getRegistrationExceptions() {
        return registrationExceptions;
    }

    /**
     * Sets the full registrations exception map. This will overwrite any previously saved mappings.
     * @param registrationExceptions the new full registrations exception map.
     */
    public void setRegistrationExceptionsMap(Map registrationExceptions)
    {
        this.registrationExceptions = registrationExceptions;
    }
}