ODLUX DB API Extension for Userdata

To be able to save user-specific data, such as settings for the NetworkMap (customization options) or the dashboard, the data-provider (Data-Provider) should be extended.

Goal:

• Provide a function to GET settings data by username
• Provide a function to POST / (PUT / PATCH?) settings data for a specific user
• Provide a function to DELETE settings data of a specific user
• no clear payload data structure definition to keep it as flexible as possible => what is written, can be requested

Characteristics:

• user gets identified by token (basicAuth or JWT)
• Additional API in bundle data-provider
• Create a settings entry in the database if none exists
• Delivers back all settings of a user
• Updates the settings of a user 
• Can delete (reset) settings of a user
• model is using camelCase for properties
• subItems have to be also JSONObjects, not Arrays or simple types
• UI is responsible for data-structure → initial data is written by UI
  • empty data on server will return empty json object: "{}"
• partial updates and requests are possible ( (filter) by root element key, see examples)

Default values for deployment

It is now possible to deploy a default userdata file ($ODL_HOME/etc/userdata-defaults.json) into the SDNC container which delivers a merge of its values and the DB entry of the userdata.

Global settings for all users should be placed here, for example, available themes for the Network Map.

Extension of data-provider

In fact, that jetty servlets can also handle camelCase URLs it is easily possible to filter for the correct property.

Examples

Read settings data of a user

GET /userdata

{
    "networkMap":{
        "startupPosition": {"lat": 52.5095, "lon":13.3290, "zoom": 10},
        "tileOpacity": 90,
        "styling":{
            "theme": "light"
        }
    },
	"networkMapThemes":{
		"themes": [
    		{"key": "light", "site": "#11b4da", "selectedSite": "#116bda", "fiberLink": "#1154d9", "microwaveLink": "#039903"}
		]
	},
    "dashboard":{
        "color":"#F00"
    }
}

GET /userdata/networkMap

{
    "startupPosition": {"lat": 52.5095, "lon":13.3290, "zoom": 10},
    "tileOpacity": 90,
    "styling":{
        "theme": "light"
    }
}

Write settings data of a user

PUT /userdata

{
    "networkMap":{
        "startupPosition": {"lat": 52.5095, "lon":13.3290, "zoom": 10},
        "tileOpacity": 90,
        "styling":{
            "theme": "light"
        }
    },
    "dashboard":{
        "color":"#F00"
    }
}

Write partial settings data of a user

PUT /userdata/networkMap

{
    "startupPosition": {"lat": 52.5095, "lon":13.3290, "zoom": 10},
    "tileOpacity": 90,
    "styling":{
        "theme": "light"
    }
}