com.microsoft.azure.sdk.iot.device.hsm.parser.TrustBundleResponse 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. 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.hsm.parser;

import com.google.gson.GsonBuilder;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;

/**
 * The json parser for the response from an HSM that contains the certificates to be trusted
 */
@SuppressWarnings("unused") // A number of private members are unused but may be filled in or used by serialization
public class TrustBundleResponse
{
    private static final String CERTIFICATE_NAME = "certificate";
    @Expose(serialize = false)
    @SerializedName(CERTIFICATE_NAME)
    private String certificates;

    /**
     * Constructor that deserializes from json
     * @param json the json representation of the TrustBundleResponse
     * @return  the created trustBundleResponse instance
     */
    public static TrustBundleResponse fromJson(String json)
    {
        TrustBundleResponse response = new GsonBuilder().create().fromJson(json, TrustBundleResponse.class);

        if (response == null || response.certificates == null || response.certificates.isEmpty())
        {
            throw new IllegalArgumentException("The provided json did not contain any certificates");
        }

        return response;
    }

    /**
     * Empty constructor, only for gson. Don't delete
     */
    public TrustBundleResponse()
    {
    }

    /**
     * Retreive the certificates that the HSM dictates to trust
     * @return one to many concatenated certificate strings to trust
     */
    public String getCertificates()
    {
        return this.certificates;
    }
}