com.livio.BSON.BsonEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdl_java_se Show documentation

The app library component of SDL is meant to run on the end userâs smart-device from within SDL enabled apps, as an embedded app, or connected to the cloud. App libraries allow the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP for Android, and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.

There is a newer version: 5.7.0

Show newest version

/*
 * Copyright (c) 2019, Livio, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Livio Inc. nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.livio.BSON;

import com.smartdevicelink.util.DebugTool;

import org.bson.BSONObject;
import org.bson.BasicBSONDecoder;
import org.bson.BasicBSONEncoder;
import org.bson.BasicBSONObject;

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

public class BsonEncoder {
    private static final String TAG = "BsonEncoder";

    public static byte[] encodeToBytes(HashMap map) throws ClassCastException {
        if (map != null) {
            BasicBSONObject bson = new BasicBSONObject();
            bson.putAll(sanitizeMap(map));
            BasicBSONEncoder encoder = new BasicBSONEncoder();

            return encoder.encode(bson);
        }
        DebugTool.logError(TAG, "Something went wrong encoding the map into BSON bytes");

        return null;
    }

    public static HashMap decodeFromBytes(byte[] bytes) {
        if (bytes != null) {
            BasicBSONDecoder decoder = new BasicBSONDecoder();
            BSONObject object = decoder.readObject(bytes);
            if (object != null) {
                Map map = object.toMap();
                if (map != null) {
                    return sanitizeMap(new HashMap<>(map));
                }
            }
        }
        DebugTool.logError(TAG, "Something went wrong decoding bytes into BSON");
        return null;
    }

    /**
     * Goes through the map and ensures that all the values included are supported by SDL. If they are not of a supported
     * value it is removed from the map
     *
     * @param map the map to be sanitized
     * @return a sanitized HashMap with non-supported object type removes
     */
    private static HashMap sanitizeMap(HashMap map) {
        Set keys = map.keySet();
        Object value;
        for (String key : keys) {
            value = map.get(key);

            //First check to see if it value is a valid type used in SDL
            if (isSupportedType(value)) {
                continue;
            } else if (value instanceof List) { //Next, check to see if it is a list of values
                List list = (List) value;

                //If the list is empty, there shouldn't be a problem leaving it in the map
                if (list.isEmpty()) {
                    continue;
                }

                //Since the list isn't empty, check the first item
                if (isSupportedType(list.get(0))) {
                    continue;
                }
            }
            //If the item isn't valid, remove it from the map
            map.remove(key);

        }
        return map;
    }

    /**
     * Checks the value to ensure it is of a supported type
     *
     * @param value the generic object value
     * @return if the object is an instanceOf one of the supported SDL BSON objects
     */
    private static boolean isSupportedType(Object value) {
        return value instanceof Integer
                || value instanceof Long
                || value instanceof Double
                || value instanceof String
                || value instanceof Boolean;
    }

}