com.microsoft.azure.sdk.iot.device.net.IotHubAbandonUri Maven / Gradle / Ivy

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. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

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

/**
 * A URI for a device to instruct an IoT Hub to mark a message as being
 * abandoned.
 */
public final class IotHubAbandonUri
{
    /**
     * The path to be appended to an IoT Hub URI. The %s will be replaced by the
     * message etag.
     */
    private static final String ABANDON_PATH_FORMAT =
            "/messages/devicebound/%s/abandon";

    /** The underlying IoT Hub URI. */
    private final IotHubUri uri;

    /**
     * Constructor. Returns a URI for a device to instruct an IoT Hub to mark a
     * message as being abandoned. The URI does not include a protocol.
     *
     * @param iotHubHostname the IoT Hub name.
     * @param deviceId the device ID.
     * @param eTag the message e-tag.
     */
    public IotHubAbandonUri(String iotHubHostname, String deviceId, String eTag)
    {
        // Codes_SRS_IOTHUBABANDONURI_11_001: [The constructor returns a URI with the format "[iotHubHostname]/devices/[deviceId]/messages/devicebound/[eTag]/abandon?api-version=2016-02-03".]
        String abandonPath = String.format(ABANDON_PATH_FORMAT, eTag);
        this.uri = new IotHubUri(iotHubHostname, deviceId, abandonPath);
    }

    /**
     * Returns the string representation of the IoT Hub abandon message URI.
     *
     * @return the string representation of the IoT Hub abandon mesasge URI.
     */
    @Override
    public String toString()
    {
        // Codes_SRS_IOTHUBABANDONURI_11_002: [The string representation of the IoT Hub event URI shall be constructed with the format "[iotHubHostname]/devices/[deviceId]/messages/devicebound/[eTag]/abandon?api-version=2016-02-03".]
        return this.uri.toString();
    }

    /**
     * Returns the string representation of the IoT Hub hostname.
     *
     * @return the string representation of the IoT Hub hostname.
     */
    public String getHostname()
    {
        // Codes_SRS_IOTHUBABANDONURI_11_003: [The function shall return the hostname given in the constructor.]
        return this.uri.getHostname();
    }

    /**
     * Returns the string representation of the IoT Hub path.
     *
     * @return the string representation of the IoT Hub path.
     */
    public String getPath()
    {
        // Codes_SRS_IOTHUBABANDONURI_11_004: [The function shall return a URI with the format '/devices/[deviceId]/messages/devicebound/[eTag]/abandon'.]
        return this.uri.getPath();
    }

    protected IotHubAbandonUri()
    {
        this.uri = null;
    }
}