com.microsoft.azure.sdk.iot.device.edge.DirectMethodRequest 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.edge;

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

/**
 * Json parser for a method request. Used to invoke methods on other devices/modules
 */
// This suppression below is addressing warnings of fields used for serialization.
@SuppressWarnings({"FieldCanBeLocal", "unused"})
public class DirectMethodRequest
{
    private static final String METHOD_NAME_KEY_NAME = "methodName";
    @Expose(deserialize = false)
    @SerializedName(METHOD_NAME_KEY_NAME)
    private String methodName;

    private static final String RESPONSE_TIMEOUT_KEY_NAME = "responseTimeoutInSeconds";
    @Expose(deserialize = false)
    @SerializedName(RESPONSE_TIMEOUT_KEY_NAME)
    private Integer responseTimeoutInSeconds; //Integer, not int because Integer is nullable, so json won't include this field if it is left as the default value

    private static final String CONNECT_TIMEOUT_KEY_NAME = "connectTimeoutInSeconds";
    @Expose(deserialize = false)
    @SerializedName(CONNECT_TIMEOUT_KEY_NAME)
    private Integer connectionTimeoutInSeconds; //Integer, not int because Integer is nullable, so json won't include this field if it is left as the default value

    private static final String PAYLOAD_KEY_NAME = "payload";
    @Expose(deserialize = false)
    @SerializedName(PAYLOAD_KEY_NAME)
    private Object payload;

    /**
     * Constructor for a DirectMethodRequest. Uses default responseTimeout and connectionTimeout which is to never timeout
     * @param methodName the method to be invoked
     * @param payload the payload attached to that method. This parameter can be
         * Null: the DirectMethodRequest object will not include the "payload" field
         * Primitive type (e.g., String, Int)/Array/List/Map/custom type: will be serialized as value of the "payload" field using GSON.
     * @throws IllegalArgumentException if the provided methodName is null or empty
     */
    public DirectMethodRequest(String methodName, Object payload) throws IllegalArgumentException
    {
        this(methodName, payload, null, null);
    }

    /**
     * Constructor for a DirectMethodRequest.
     * @param methodName the method to be invoked
     * @param payload the payload attached to that method. This parameter can be
         * Null: the DirectMethodRequest object will not include the "payload" field
         * Primitive type (e.g., String, Int)/Array/List/Map/custom type: will be serialized as value of the "payload" field using GSON.
     * @param responseTimeout the timeout in seconds for the response to be received
     * @param connectionTimeout the timeout in seconds for the connection to be established
     * @throws IllegalArgumentException if the provided methodName is null or empty
     */
    public DirectMethodRequest(String methodName, Object payload, Integer responseTimeout, Integer connectionTimeout) throws IllegalArgumentException
    {
        if (methodName == null || methodName.isEmpty())
        {
            throw new IllegalArgumentException("MethodName cannot be null or empty");
        }

        this.payload = payload;
        this.methodName = methodName;
        this.responseTimeoutInSeconds = responseTimeout;
        this.connectionTimeoutInSeconds = connectionTimeout;
    }

    /**
     * Return the json representation of this object
     * @return the json representation of this object
     */
    public String toJson()
    {
        return new GsonBuilder().create().toJson(this);
    }

    //empty constructor for gson
    DirectMethodRequest() { }
}