com.microsoft.azure.sdk.iot.device.twin.MethodParser 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
Show all versions of iot-device-client Show documentation
The Microsoft Azure IoT Device SDK for Java
// 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.twin;
import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonNull;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import com.google.gson.JsonPrimitive;
import com.google.gson.JsonSyntaxException;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;
import lombok.Getter;
import lombok.Setter;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
/**
* Representation of a single Direct Method Access collection with a Json serializer and deserializer.
*/
public class MethodParser
{
protected enum Operation
{
invoke,
response,
payload,
none
}
@Expose(serialize = false, deserialize = false)
private Operation operation;
private static final String METHOD_NAME_TAG = "methodName";
@Expose(deserialize = false)
@SerializedName(METHOD_NAME_TAG)
@Getter
@Setter
private String name;
private static final String RESPONSE_TIMEOUT_IN_SECONDS_TAG = "responseTimeoutInSeconds";
@Expose(deserialize = false)
@SerializedName(RESPONSE_TIMEOUT_IN_SECONDS_TAG)
@Getter
@Setter
private Long responseTimeout;
private static final String CONNECT_TIMEOUT_IN_SECONDS_TAG = "connectTimeoutInSeconds";
@Expose(deserialize = false)
@SerializedName(CONNECT_TIMEOUT_IN_SECONDS_TAG)
@Getter
@Setter
private Long connectTimeout;
private static final String STATUS_TAG = "status";
@Expose(serialize = false)
@SerializedName(STATUS_TAG)
@Getter
@Setter
private Integer status;
private static final String PAYLOAD_TAG = "payload";
@SerializedName(PAYLOAD_TAG)
@Setter
private JsonElement payload;
/**
* CONSTRUCTOR
* Create a MethodParser instance with provided values.
*/
public MethodParser()
{
this.name = null;
this.responseTimeout = null;
this.connectTimeout = null;
this.status = null;
this.payload = null;
this.operation = Operation.none;
}
/**
* CONSTRUCTOR
* Create a MethodParser instance with provided values.
*
* @param name - method name [required].
* @param responseTimeout - maximum interval of time, in seconds, that the Direct Method will wait for answer. It can be {@code null}.
* @param connectTimeout - maximum interval of time, in seconds, that the Direct Method will wait for the connection. It can be {@code null}.
* @param payload - Object that contains the payload defined by the user. It can be {@code null}.
* @throws IllegalArgumentException This exception is thrown if the one of the provided information do not fits the requirements.
*/
public MethodParser(String name, Long responseTimeout, Long connectTimeout, JsonElement payload) throws IllegalArgumentException
{
this();
validateKey(name);
if (responseTimeout != null)
{
validateTimeout(responseTimeout);
}
if (connectTimeout != null)
{
validateTimeout(connectTimeout);
}
this.name = name;
this.responseTimeout = responseTimeout;
this.connectTimeout = connectTimeout;
this.payload = payload;
this.operation = Operation.invoke;
}
/**
* CONSTRUCTOR
* Create a MethodParser instance with provided values.
*
* @param payload - Object that contains the payload defined by the user. It can be {@code null}.
*/
public MethodParser(JsonElement payload)
{
this();
this.payload = payload;
this.operation = Operation.payload;
}
/**
* Set the Method collection with the provided information in the json.
*
* @param json - Json with the information to change the collection.
* - If contains `methodName`, it is a full method including `methodName`, `responseTimeoutInSeconds`, `connectTimeoutInSeconds`, and `payload`.
* - If contains `status`, it is a response with `status` and `payload`.
* - Otherwise, it is only `payload`.
* @throws IllegalArgumentException This exception is thrown if the one of the provided information do not fits the requirements.
*/
public synchronized void fromJson(String json) throws IllegalArgumentException
{
if (json == null || json.isEmpty())
{
throw new IllegalArgumentException("Invalid json.");
}
JsonParser jsonParser = new JsonParser();
try
{
JsonElement jsonElement = jsonParser.parse(json);
if (jsonElement instanceof JsonPrimitive || jsonElement instanceof JsonArray)
{
/*
Basic JSON String or Array
Ex:
"this is payload."
1
true
2.0e10
2.6
*/
this.operation = Operation.payload;
this.payload = jsonElement;
}
else if (jsonElement instanceof JsonObject)
{
JsonObject jsonObject = (JsonObject) jsonElement;
JsonElement statusTagNode = jsonObject.get(STATUS_TAG);
JsonElement methodNameNode = jsonObject.get(METHOD_NAME_TAG);
if (methodNameNode == null)
{
if (statusTagNode == null)
{
/*
If the json contains any payload without `methodName` or `status` identification, the fromJson shall parse only the payload, and set the operation as `payload`.
Ex:
{
"input1": "someInput",
"input2": "anotherInput"
}
*/
operation = Operation.payload;
payload = jsonObject;
}
else
{
/*
If the json contains the `status` identification, the fromJson shall parse both status and payload, and set the operation as `response`.
Ex:
{
"status": 201,
"payload": {"AnyValidPayload" : "" }
}
*/
operation = Operation.response;
if (statusTagNode.isJsonPrimitive())
{
status = statusTagNode.getAsInt();
}
JsonElement payloadNode = jsonObject.get(PAYLOAD_TAG);
if (payloadNode != null)
{
payload = payloadNode;
}
}
}
else
{
if (statusTagNode == null)
{
/*
If the json contains the `methodName` identification, the fromJson shall parse the full method, and set the operation as `invoke`.
Ex:
{
"methodName": "reboot",
"responseTimeoutInSeconds": 200,
"connectTimeoutInSeconds": 5,
"payload":
{
"input1": "someInput",
"input2": "anotherInput"
}
}
*/
operation = Operation.invoke;
name = methodNameNode.getAsString();
JsonElement responseTimeoutNode = jsonObject.get(RESPONSE_TIMEOUT_IN_SECONDS_TAG);
if (responseTimeoutNode != null)
{
responseTimeout = responseTimeoutNode.getAsLong();
}
JsonElement connetionTimeoutNode = jsonObject.get(CONNECT_TIMEOUT_IN_SECONDS_TAG);
if (connetionTimeoutNode != null)
{
connectTimeout = connetionTimeoutNode.getAsLong();
}
JsonElement payloadNode = jsonObject.get(PAYLOAD_TAG);
if (payloadNode != null)
{
payload = payloadNode;
}
}
else
{
throw new IllegalArgumentException("Invoke method name and Status reported in the same json");
}
}
}
else
{
// JSON null, since string is not empty, it shouldn't reach here
throw new IllegalArgumentException("Invalid json.");
}
}
catch (Exception ex)
{
throw new IllegalArgumentException("Malformed json.", ex);
}
}
public JsonElement getPayloadFromJson(String json)
{
if (json == null || json.isEmpty())
{
return new JsonObject();
}
JsonElement jsonElement = new JsonParser().parse(json);
return jsonElement;
}
/**
* Return an Object with the payload.
*
* @return An Object with the payload. It can be {@code null}.
*/
public JsonElement getPayload()
{
return payload;
}
/**
* Create a String with a json content that represents all the information in the method collection.
*
* @return String with the json content.
* @throws IllegalArgumentException This exception is thrown if the one of the provided information do not fits the requirements.
*/
public String toJson() throws IllegalArgumentException
{
return toJsonElement().toString();
}
// Unchecked casts of Maps to Map are safe as long as service is returning valid twin json payloads. Since all json keys are Strings, all maps must be Map
@SuppressWarnings("unchecked")
private JsonElement jsonizePayload(Object payload)
{
if (payload == null)
{
return JsonNull.INSTANCE;
}
else if (payload instanceof JsonElement)
{
return (JsonElement) payload;
}
else if (payload instanceof Map)
{
JsonObject jsonObject = new JsonObject();
Set> entrySet = ((Map) payload).entrySet();
for (Entry entry : entrySet)
{
jsonObject.add(entry.getKey(), jsonizePayload(entry.getValue()));
}
return jsonObject;
}
else
{
JsonParser parser = new JsonParser();
try
{
String json = payload.toString();
JsonElement jsonElement = parser.parse(json);
if (jsonElement.isJsonNull())
{
return new JsonPrimitive(json);
}
else
{
return jsonElement;
}
}
catch (JsonSyntaxException e)
{
return new Gson().toJsonTree(payload);
}
}
}
/**
* Create a JsonElement with a content that represents all the information in the method collection.
*
* @return JsonElement with the content.
* @throws IllegalArgumentException This exception is thrown if the one of the provided information do not fits the requirements.
*/
public JsonElement toJsonElement() throws IllegalArgumentException
{
if (operation == Operation.invoke)
{
/*
If the method operation is `invoke`, the toJsonElement shall include the full method information in the json.
Ex:
{
"methodName": "reboot",
"responseTimeoutInSeconds": 200,
"connectTimeoutInSeconds": 5,
"payload":
{
"input1": "someInput",
"input2": "anotherInput"
}
}
*/
if ((name == null) || name.isEmpty())
{
throw new IllegalArgumentException("cannot invoke method with null name");
}
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty(METHOD_NAME_TAG, name);
if (responseTimeout != null)
{
jsonObject.addProperty(RESPONSE_TIMEOUT_IN_SECONDS_TAG, responseTimeout);
}
if (connectTimeout != null)
{
jsonObject.addProperty(CONNECT_TIMEOUT_IN_SECONDS_TAG, connectTimeout);
}
jsonObject.add(PAYLOAD_TAG, jsonizePayload(payload));
return jsonObject;
}
else if (operation == Operation.response)
{
/*
If the method operation is `response`, the toJsonElement shall parse both status and payload.
Ex:
{
"status": 201,
"payload": {"AnyValidPayload" : "" }
}
*/
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty(STATUS_TAG, status);
jsonObject.add(PAYLOAD_TAG, jsonizePayload(payload));
return jsonObject;
}
else if (operation == Operation.payload)
{
/*
If the method operation is `payload`, the toJsonElement shall parse only the payload.
Ex:
{
"input1": "someInput",
"input2": "anotherInput"
}
*/
return jsonizePayload(payload);
}
else
{
throw new IllegalArgumentException("There is no content to parser");
}
}
/**
* Validation helper, make sure that the key fits the requirements.
*
* @param key is a key string. It can be name or an Json key in a Map.
* @throws IllegalArgumentException This exception is thrown if the provided Key do not fits the requirements.
*/
private void validateKey(String key) throws IllegalArgumentException
{
if ((key == null) || (key.isEmpty()))
{
throw new IllegalArgumentException("Key cannot be null or empty");
}
if (key.length() > 128)
{
throw new IllegalArgumentException("Key cannot be longer than 128 characters");
}
if (key.contains("$") || key.contains(".") || key.contains(" "))
{
throw new IllegalArgumentException("Key cannot contain '$', '.', or space");
}
}
/**
* Validation helper, make sure that timeout values fit the requirements.
*
* @param timeout is the timeout value in seconds.
* @throws IllegalArgumentException This exception is thrown if the provided timeout value do not fits the requirements.
*/
private void validateTimeout(Long timeout) throws IllegalArgumentException
{
if (timeout < 0)
{
throw new IllegalArgumentException("Negative timeout");
}
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy