view web/common/src/main/java/com/redhat/thermostat/web/common/OperatorSerializer.java @ 1140:bf720980510c

Handle boolean formulas in Query.where This commit adds a hierarchy of expressions to storage-core. These expressions are used to create more general boolean formulas for queries than we currently support. Most importantly, this will allow us to use disjunctions in queries. Expressions are created using the ExpressionFactory methods corresponding to each operator. For instance, expressions created by the factory's "greaterThan" and "lessThan" methods can then be joined using the factory's "and" or "or" methods. These expressions are serialized/deserialized to/from JSON by the new ExpressionSerializer and OperatorSerializer classes. These serializers are written to only handle Expression subclasses that it knows about, and these concrete Expression classes are all declared final. This should help prevent the web service from handling malicious arbitrary queries. Ideally I would have liked to make all Expression constructors package-private and require that all instantiations be done through the factory, but the need to deserialize expressions from JSON prevents this unless we want storage-core to deal with JSON. The MongoDB storage backend uses a new MongoExpressionParser class to convert an expression into a Mongo query. Conjunctions are handled differently now. MongoDB supports implicit and explicit conjunctions. Previously, our MongoQuery.where appended new clauses to the query in each successive call. This resulted in an implicit conjunction of these clauses. Now we create explicit conjunctions using the $and operator. This has a couple of advantages: short-circuiting, and the ability to specify the same key twice (e.g. x > 7 && x < 10). Reviewed-by: jerboaa Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-June/006932.html
author Elliott Baron <ebaron@redhat.com>
date Fri, 07 Jun 2013 13:49:04 -0400
parents
children
line wrap: on
line source

/*
 * Copyright 2012, 2013 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.web.common;

import java.lang.reflect.Type;

import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;
import com.redhat.thermostat.storage.query.Operator;

public class OperatorSerializer implements JsonDeserializer<Operator>,
        JsonSerializer<Operator> {
    /* The name of the enum constant */
    static final String PROP_CONST = "PROP_CONST";
    /* The Operator implementation fully-qualified class name */
    static final String PROP_CLASS_NAME = "PROP_CLASS_NAME";

    @Override
    public JsonElement serialize(Operator src, Type typeOfSrc,
            JsonSerializationContext context) {
        JsonObject result = new JsonObject();
        // All concrete Operators should be Enums
        if (src instanceof Enum) {
            Enum<?> operator = (Enum<?>) src;
            result.addProperty(PROP_CONST, operator.name());
            result.addProperty(PROP_CLASS_NAME, operator.getDeclaringClass().getCanonicalName());
        }
        else {
            throw new JsonParseException("Concrete Operator must be an enum");
        }
        return result;
    }

    @Override
    public Operator deserialize(JsonElement json, Type typeOfT,
            JsonDeserializationContext context) throws JsonParseException {
        JsonElement jsonClassName = json.getAsJsonObject().get(PROP_CLASS_NAME);
        if (jsonClassName == null) {
            throw new JsonParseException("Class name must be specified for Operator");
        }
        String className = jsonClassName.getAsString();
        Operator result;
        try {
            Class<?> clazz = Class.forName(className);
            result = getEnum(json, clazz);
        } catch (ClassNotFoundException e) {
            throw new JsonParseException("Unable to deserialize Operator", e);
        }
        return result;
    }

    private <T extends Enum<T> & Operator> Operator getEnum(JsonElement json, Class<?> clazz) {
        if (Operator.class.isAssignableFrom(clazz) && clazz.isEnum()) {
            @SuppressWarnings("unchecked") // Checked with above condition
            Class<T> operatorClass = (Class<T>) clazz;
            JsonElement jsonConst = json.getAsJsonObject().get(PROP_CONST);
            String enumConst = jsonConst.getAsString();
            return Enum.valueOf(operatorClass, enumConst);
        }
        else {
            throw new JsonParseException(clazz.getName() + " must be an Enum implementing Operator");
        }
    }

}