Package org.openremote.model.map

Interface MapResource

@Path("map")
public interface MapResource

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	deleteMap(RequestParams requestParams)	Removes mbtiles file
com.fasterxml.jackson.databind.node.ObjectNode	getCustomMapInfo()	Retrieve if the map is custom and custom map limit
com.fasterxml.jackson.databind.node.ObjectNode	getSettings(RequestParams requestParams)	Returns style used to initialise Mapbox GL
com.fasterxml.jackson.databind.node.ObjectNode	getSettingsJs(RequestParams requestParams)	Returns tileJSON object used to initialise Mapbox JS
byte[]	getTile(int zoom, int column, int row)	Gets vector tile data for Mapbox GL
com.fasterxml.jackson.databind.node.ObjectNode	saveSettings(RequestParams requestParams, MapConfig mapConfig)	Saves the settings for maps
com.fasterxml.jackson.databind.node.ObjectNode	uploadMap(RequestParams requestParams, String filename)	Saves mbtiles file

Method Details

saveSettings

@PUT
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:admin")
com.fasterxml.jackson.databind.node.ObjectNode saveSettings(@BeanParam
 RequestParams requestParams,
 MapConfig mapConfig)

Saves the settings for maps

getSettings

@GET
@Produces("application/json")
com.fasterxml.jackson.databind.node.ObjectNode getSettings(@BeanParam
 RequestParams requestParams)

Returns style used to initialise Mapbox GL

Returns:

getSettingsJs

@GET
@Path("js")
@Produces("application/json")
com.fasterxml.jackson.databind.node.ObjectNode getSettingsJs(@BeanParam
 RequestParams requestParams)

Returns tileJSON object used to initialise Mapbox JS

Returns:

getTile

@GET
@Produces("application/vnd.mapbox-vector-tile")
@Path("tile/{zoom}/{column}/{row}")
byte[] getTile(@PathParam("zoom")
 int zoom,
 @PathParam("column")
 int column,
 @PathParam("row")
 int row)

Gets vector tile data for Mapbox GL

uploadMap

@POST
@Path("upload")
@Consumes("application/octet-stream")
@Produces("application/json")
@RolesAllowed("write:admin")
com.fasterxml.jackson.databind.node.ObjectNode uploadMap(@BeanParam
 RequestParams requestParams,
 @QueryParam("filename")
 String filename)

Saves mbtiles file

getCustomMapInfo

@GET
@Path("getCustomMapInfo")
@Produces("application/json")
@RolesAllowed("read:admin")
com.fasterxml.jackson.databind.node.ObjectNode getCustomMapInfo()

Retrieve if the map is custom and custom map limit

deleteMap

@DELETE
@Path("deleteMap")
@Produces("application/json")
@RolesAllowed("write:admin")
com.fasterxml.jackson.databind.node.ObjectNode deleteMap(@BeanParam
 RequestParams requestParams)

Removes mbtiles file