Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/heremaps/here-artifact-sbt-resolver

The HERE platform SBT Resolver plugin provides Java and Scala developers with access to platform artifacts via SBT
https://github.com/heremaps/here-artifact-sbt-resolver

here-workspace sbt sbt-resolver scala

Last synced: 1 day ago
JSON representation

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

Awesome Lists containing this project

README 

        
[![Build Status](https://github.com/heremaps/here-artifact-sbt-resolver/actions/workflows/release.yml/badge.svg)](https://github.com/heremaps/here-artifact-sbt-resolver/actions?query=workflow%3ARelease+branch%3Amaster)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.here.platform.artifact/sbt-resolver/badge.svg)](https://search.maven.org/artifact/com.here.platform.artifact/sbt-resolver)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)



# HERE SBT Resolver for Workspace and Marketplace



## 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](https://www.here.com/docs/bundle/here-workspace-developer-guide-java-scala/page/proto-schema/README.html).

In addition, the users can [fetch the Java / Scala Data Client Library](https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/get-data.html)

which offer access to data in the HERE Data API.



Go to [the HERE Developer portal](https://developer.here.com/products/platform) 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](https://www.here.com/get-started/pricing) 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](https://www.here.com/docs/bundle/here-workspace-developer-guide-java-scala/page/topics/how-to-use-sdk.html).

Marketplace users can find instructions in the [Marketplace Consumer user guide](https://www.here.com/docs/bundle/marketplace-consumer-user-guide/page/topics/link-catalogs.html#set-up-your-credentials).



Please note, by default the SBT Resolver plugin uses the `credentials.properties` file provided in the `.here` directory in the user home directory. 

There are two options to override the path:

- The first option is the system property `hereCredentialsFile`, the property should be added to the sbt command the following way `-DhereCredentialsFile=/full/path/to/credentials.properties`.

- The second option is the environment variable `HERE_CREDENTIALS_FILE`.  The variable should contain the full file path to the `credentials.properties` file to be used. The variable is taken into account only if there is no system property provided.



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](https://search.maven.org/artifact/com.here.platform.artifact/sbt-resolver)

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](https://www.here.com/docs/bundle/here-workspace-developer-guide-java-scala/page/sdk-libraries.html).



#### 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:

```shell

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:

```shell

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

```



## License

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



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