Share via

Azure Maps SDK Render client library for Java - version 1.0.0-beta.2

  • Article

Azure Maps SDK Render client library for Java.

This package contains Microsoft Azure SDK for Render Management SDK which contains Azure Maps Render REST APIs. Azure Maps Render retrieves copyrigt information or map/state tiles. For documentation on how to use this package, please see Azure Maps Render.

Source code | API reference documentation | REST API documentation | Product documentation | Samples

Documentation

Various documentation is available to help you get started

Getting started

Prerequisites

Adding the package to your product

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-maps-render</artifactId>
    <version>1.0.0-beta.2</version>
</dependency>

Azure Maps Libraries require a TokenCredential implementation for authentication and an HttpClient implementation for HTTP client.

Azure Identity package and Azure Core Netty HTTP package provide the default implementation.

Authentication

By default, Azure Active Directory token authentication depends on correct configure of following environment variables.

  • AZURE_CLIENT_ID for Azure client ID.
  • AZURE_TENANT_ID for Azure tenant ID.
  • AZURE_CLIENT_SECRET or AZURE_CLIENT_CERTIFICATE_PATH for client secret or client certificate.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, azure client can be authenticated by following code:

// Authenticates using Azure AD building a default credential
// This will look for AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET env variables
DefaultAzureCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

// Creates a builder
MapsRenderClientBuilder builder = new MapsRenderClientBuilder();
builder.credential(tokenCredential);
builder.mapsClientId(System.getenv("MAPS_CLIENT_ID"));
builder.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS));

// Builds a client
MapsRenderClient client = builder.buildClient();

The sample code assumes global Azure. Please change AzureEnvironment.AZURE variable if otherwise.

See Authentication for more options.

Key concepts

See API design for general introduction on design and key concepts on Azure Management Libraries.

Examples

Get Map Tile

System.out.println("Get Map Tile");
MapTileOptions mapTileOptions = new MapTileOptions();
mapTileOptions.setTilesetId(TilesetId.MICROSOFT_BASE_ROAD);
mapTileOptions.setTileIndex(new TileIndex().setX(10).setY(22).setZ(6));
client.getMapTile(mapTileOptions);

Get Map Tileset

System.out.println("Get Map Tileset");
new TilesetId();
client.getMapTileset(TilesetId.MICROSOFT_BASE);

Get Map Attribution

System.out.println("Get Map Attribution");
GeoBoundingBox bounds = new GeoBoundingBox(-122.414162, 47.57949, -122.247157, 47.668372);
new TilesetId();
client.getMapAttribution(TilesetId.MICROSOFT_BASE, 6, bounds);

Get Copyright Caption

System.out.println("Get Copyright Caption");
client.getCopyrightCaption();

Get Map Static Image

System.out.println("Get Map Static Image");
GeoBoundingBox bbox = new GeoBoundingBox(1.355233, 42.982261, 24.980233, 56.526017);
new StaticMapLayer();
new RasterTileFormat();
MapStaticImageOptions mapStaticImageOptions = new MapStaticImageOptions().setStaticMapLayer(StaticMapLayer.BASIC)
    .setMapImageStyle(MapImageStyle.MAIN).setZoom(2)
    .setBoundingBox(bbox).setRasterTileFormat(RasterTileFormat.PNG);
client.getMapStaticImage(mapStaticImageOptions).toStream();

Get Copyright From Bounding Box

GeoBoundingBox boundingBox = new GeoBoundingBox(52.41064, 4.84228, 52.41072, 4.84239);
client.getCopyrightFromBoundingBox(boundingBox, true);

Get Copyright For Tile

client.getCopyrightForTile(new TileIndex().setX(9).setY(22).setZ(6), true);

Get Copyright For World

client.getCopyrightForWorld(true);

Troubleshooting

When you interact with the Azure Maps Services, errors returned by the Maps service correspond to the same HTTP status codes returned for REST API requests.

For example, if you search with an invalid coordinate, a error is returned, indicating "Bad Request".400

Next steps

Several Azure Maps Render Java SDK samples are available to you in the SDK's GitHub repository. Azure Maps Render Samples

Contributing

For details on contributing to this repository, see the contributing guide.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Impressions