vaadin-framework/src/com/vaadin/terminal/gwt/client/communication/JsonEncoder.java

/*
@VaadinApache2LicenseForJavaFiles@
 */

package com.vaadin.terminal.gwt.client.communication;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.google.gwt.json.client.JSONArray;
import com.google.gwt.json.client.JSONBoolean;
import com.google.gwt.json.client.JSONNull;
import com.google.gwt.json.client.JSONObject;
import com.google.gwt.json.client.JSONString;
import com.google.gwt.json.client.JSONValue;
import com.vaadin.terminal.gwt.client.ApplicationConnection;
import com.vaadin.terminal.gwt.client.Connector;
import com.vaadin.terminal.gwt.client.ConnectorMap;

/**
 * Encoder for converting RPC parameters and other values to JSON for transfer
 * between the client and the server.
 * 
 * Currently, basic data types as well as Map, String[] and Object[] are
 * supported, where maps and Object[] can contain other supported data types.
 * 
 * TODO extensible type support
 * 
 * @since 7.0
 */
public class JsonEncoder {

    public static final String VTYPE_CONNECTOR = "c";
    public static final String VTYPE_BOOLEAN = "b";
    public static final String VTYPE_DOUBLE = "d";
    public static final String VTYPE_FLOAT = "f";
    public static final String VTYPE_LONG = "l";
    public static final String VTYPE_INTEGER = "i";
    public static final String VTYPE_STRING = "s";
    public static final String VTYPE_ARRAY = "a";
    public static final String VTYPE_STRINGARRAY = "S";
    public static final String VTYPE_MAP = "m";
    // Hack to support Map<Connector,?>. Should be replaced by generic support
    // for any object as key (#8602)
    @Deprecated
    public static final String VTYPE_MAP_CONNECTOR = "M";
    public static final String VTYPE_LIST = "L";
    public static final String VTYPE_SET = "q";
    public static final String VTYPE_NULL = "n";

    /**
     * Encode a value to a JSON representation for transport from the client to
     * the server.
     * 
     * @param value
     *            value to convert
     * @param connectorMap
     *            mapper from connectors to connector IDs
     * @param connection
     * @return JSON representation of the value
     */
    public static JSONValue encode(Object value, ConnectorMap connectorMap,
            ApplicationConnection connection) {
        if (null == value) {
            return combineTypeAndValue(VTYPE_NULL, JSONNull.getInstance());
        } else if (value instanceof String[]) {
            String[] array = (String[]) value;
            JSONArray jsonArray = new JSONArray();
            for (int i = 0; i < array.length; ++i) {
                jsonArray.set(i, new JSONString(array[i]));
            }
            return combineTypeAndValue(VTYPE_STRINGARRAY, jsonArray);
        } else if (value instanceof String) {
            return combineTypeAndValue(VTYPE_STRING, new JSONString(
                    (String) value));
        } else if (value instanceof Boolean) {
            return combineTypeAndValue(VTYPE_BOOLEAN,
                    JSONBoolean.getInstance((Boolean) value));
        } else if (value instanceof Object[]) {
            return encodeObjectArray((Object[]) value, connectorMap, connection);
        } else if (value instanceof Enum) {
            Enum e = (Enum) value;
            return encodeEnum(e, connectorMap, connection);
        } else if (value instanceof Map) {
            Map<Object, Object> map = (Map<Object, Object>) value;
            JSONObject jsonMap = new JSONObject();
            String type = VTYPE_MAP;
            for (Object mapKey : map.keySet()) {
                Object mapValue = map.get(mapKey);
                if (mapKey instanceof Connector) {
                    mapKey = ((Connector) mapKey).getConnectorId();
                    type = VTYPE_MAP_CONNECTOR;
                }

                if (!(mapKey instanceof String)) {
                    throw new RuntimeException(
                            "Only Map<String,?> and Map<Connector,?> is currently supported."
                                    + " Failed map used "
                                    + mapKey.getClass().getName() + " as keys");
                }
                jsonMap.put((String) mapKey,
                        encode(mapValue, connectorMap, connection));
            }
            return combineTypeAndValue(type, jsonMap);
        } else if (value instanceof Connector) {
            Connector connector = (Connector) value;
            return combineTypeAndValue(VTYPE_CONNECTOR, new JSONString(
                    connector.getConnectorId()));
        } else if (value instanceof Collection) {
            return encodeCollection((Collection) value, connectorMap,
                    connection);
        } else {
            String transportType = getTransportType(value);
            if (transportType != null) {
                return combineTypeAndValue(transportType,
                        new JSONString(String.valueOf(value)));
            } else {
                // Try to find a generated serializer object, class name is the
                // type
                transportType = value.getClass().getName();
                JSONSerializer serializer = connection.getSerializerMap()
                        .getSerializer(transportType);

                // TODO handle case with no serializer found
                return combineTypeAndValue(transportType,
                        serializer.serialize(value, connectorMap, connection));
            }
        }
    }

    private static JSONValue encodeEnum(Enum e, ConnectorMap connectorMap,
            ApplicationConnection connection) {
        return combineTypeAndValue(e.getClass().getName(),
                new JSONString(e.toString()));
    }

    private static JSONValue encodeObjectArray(Object[] array,
            ConnectorMap connectorMap, ApplicationConnection connection) {
        JSONArray jsonArray = new JSONArray();
        for (int i = 0; i < array.length; ++i) {
            // TODO handle object graph loops?
            jsonArray.set(i, encode(array[i], connectorMap, connection));
        }
        return combineTypeAndValue(VTYPE_ARRAY, jsonArray);
    }

    private static JSONValue encodeCollection(Collection collection,
            ConnectorMap connectorMap, ApplicationConnection connection) {
        JSONArray jsonArray = new JSONArray();
        int idx = 0;
        for (Object o : collection) {
            JSONValue encodedObject = encode(o, connectorMap, connection);
            jsonArray.set(idx++, encodedObject);
        }
        if (collection instanceof Set) {
            return combineTypeAndValue(VTYPE_SET, jsonArray);
        } else if (collection instanceof List) {
            return combineTypeAndValue(VTYPE_LIST, jsonArray);
        } else {
            throw new RuntimeException("Unsupport collection type: "
                    + collection.getClass().getName());
        }

    }

    private static JSONValue combineTypeAndValue(String type, JSONValue value) {
        JSONArray outerArray = new JSONArray();
        outerArray.set(0, new JSONString(type));
        outerArray.set(1, value);
        return outerArray;
    }

    /**
     * Returns the transport type for the given value. Only returns a transport
     * type for internally handled values.
     * 
     * @param value
     *            The value that should be transported
     * @return One of the JsonEncode.VTYPE_ constants or null if the value
     *         cannot be transported using an internally handled type.
     */
    private static String getTransportType(Object value) {
        if (value == null) {
            return VTYPE_NULL;
        } else if (value instanceof String) {
            return VTYPE_STRING;
        } else if (value instanceof Connector) {
            return VTYPE_CONNECTOR;
        } else if (value instanceof Boolean) {
            return VTYPE_BOOLEAN;
        } else if (value instanceof Integer) {
            return VTYPE_INTEGER;
        } else if (value instanceof Float) {
            return VTYPE_FLOAT;
        } else if (value instanceof Double) {
            return VTYPE_DOUBLE;
        } else if (value instanceof Long) {
            return VTYPE_LONG;
        } else if (value instanceof List) {
            return VTYPE_LIST;
        } else if (value instanceof Set) {
            return VTYPE_SET;
        } else if (value instanceof String[]) {
            return VTYPE_STRINGARRAY;
        } else if (value instanceof Object[]) {
            return VTYPE_ARRAY;
        } else if (value instanceof Map) {
            return VTYPE_MAP;
        }
        return null;
    }
}