heremaps / here-artifact-sbt-resolver

The HERE platform SBT Resolver plugin provides Java and Scala developers with access to platform artifacts via SBT

GitHub

Build Status Maven Central License

HERE SBT Resolver for Workspace and Marketplace (Unofficial)

Introduction

The HERE platform SBT resolver plugin provides Java and Scala developers with access to HERE platform artifacts via SBT. It uses your HERE platform credentials to generate tokens so that it can pull your SBT project dependencies from the HERE platform.

This allows Marketplace and Workspace users to fetch platform schemas. In addition, the users can fetch the Java / Scala Data Client Library which offer access to data in the HERE Data API.

Go to the HERE Developer portal to learn more about the HERE platform.

Limitation

The SBT resolver plugin is provided 'as is' and not officially part of Workspace or Marketplace. While there is no official support by HERE, you may still raise issues via GitHub. We may be able to help.

Prerequisites

To access the libraries and schemas from the HERE platform, you need a HERE Workspace and/or a HERE Marketplace account. If you don’t have an account yet, go to Pricing and Plans to apply for a free trial.

Once you have enabled your account you need to create the credentials and prepare your environment. Workspace users can find corresponding guidance in the documentation for Java and Scala developers. Marketplace users can find instructions in the Marketplace Consumer user guide.

This version is compatible with:

  • Scala 2.11/2.12
  • SBT 1.x

How to use it?

This SBT resolver plugin is published on Maven Central so you can conveniently use it from your project. The sbt-resolver plugin can be registered by adding an entry to projects/plugins.sbt file as follows:

addSbtPlugin("com.here.platform.artifact" % "sbt-resolver" % sbtResolverVersion)

For example, to fetch the HERE Map Content - Topology Geometry - Protocol Buffers schema and the related Java and Scala bindings set the following dependencies:

resolvers += "HERE_PLATFORM_ARTIFACT" at "here+artifact-service://artifact-service"

libraryDependencies += "com.here.schema.rib" % "topology-geometry_v2_proto" % topologyGeometryVersion
libraryDependencies += "com.here.schema.rib" % "topology-geometry_v2_java" % topologyGeometryVersion
libraryDependencies += "com.here.schema.rib" % "topology-geometry_v2_scala" % topologyGeometryVersion

As a Marketplace user you can add this dependency for fetching the Java / Scala Data Client Library:

resolvers += "HERE_PLATFORM_ARTIFACT" at "here+artifact-service://artifact-service"

libraryDependencies += "com.here.platform.data.client" %% "data-client" % dataClientVersion

here+artifact-service://artifact-service is placeholder URL which will be replaced by plugin dynamically based on your credentials. The latest versions of the Data Client Library and Schemas can be found in SDK documentation.

Proxy Setup

To enable SBT and the HERE SBT resolver plugin to work behind a proxy, you need to use standard http_proxy and https_proxy environment variables, like:

sbt -Dhttp.proxyHost=PROXY_HOST -Dhttp.proxyPort=PROXY_PORT -Dhttp.proxyUser=PROXY_USERNAME -Dhttp.proxyPassword=PROXY_PASSWORD

Alternatively, pass those by setting JAVA_OPTS in the environment variable, like:

export JAVA_OPTS="-Dhttp.proxyHost=PROXY_HOST -Dhttp.proxyPort=PROXY_PORT -Dhttp.proxyUser=PROXY_USERNAME -Dhttp.proxyPassword=PROXY_PASSWORD"

License

Copyright (C) 2019-2020 HERE Europe B.V.

Unless otherwise noted in LICENSE files for specific files or directories, the LICENSE in the root applies to all content in this repository.