BlackboardJsonAttrUtil.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.datamodel.blackboardutils.attributes;

import com.google.gson.Gson;
import com.google.gson.JsonSyntaxException;
import org.sleuthkit.datamodel.BlackboardAttribute;

public final class BlackboardJsonAttrUtil {

        public static <T> BlackboardAttribute toAttribute(BlackboardAttribute.Type attrType, String moduleName, T attrValue) {
                if (attrType.getValueType() != BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.JSON) {
                        throw new IllegalArgumentException(String.format("Attribute type %s does not have value type BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.JSON", attrType.getTypeName()));
                }
                return new BlackboardAttribute(attrType, moduleName, (new Gson()).toJson(attrValue));
        }

        public static <T> T fromAttribute(BlackboardAttribute attr, Class<T> clazz) throws InvalidJsonException {
                BlackboardAttribute.Type attrType = attr.getAttributeType();
                if (attrType.getValueType() != BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.JSON) {
                        throw new IllegalArgumentException(String.format("Attribute type %s does not have value type BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.JSON", attrType.getTypeName()));
                }
                String json = attr.getValueString();
                if (json == null || json.isEmpty()) {
                        throw new InvalidJsonException("The string value (JSON) of the attribute is null or empty");
                }
                try {
                        return (new Gson()).fromJson(json, clazz);
                } catch (JsonSyntaxException ex) {
                        throw new InvalidJsonException(String.format("The string value (JSON) could not be deserialized as a %s", clazz.getName()), ex);
                }
        }

        public static class InvalidJsonException extends Exception {

                private static final long serialVersionUID = 1L;

                public InvalidJsonException(String message) {
                        super(message);
                }

                public InvalidJsonException(String message, Throwable cause) {
                        super(message, cause);
                }
        }

        private BlackboardJsonAttrUtil() {
        }

}