https://github.com/sonatype/ossindex-public

Sonatype OSS Index - Public
https://github.com/sonatype/ossindex-public

java lift ossindex

Last synced: about 1 year ago
JSON representation

Sonatype OSS Index - Public

• Host: GitHub
• URL: https://github.com/sonatype/ossindex-public
• Owner: sonatype
• License: apache-2.0
• Created: 2018-05-15T22:02:08.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2022-04-27T18:49:23.000Z (about 4 years ago)
• Last Synced: 2025-04-02T21:51:22.779Z (over 1 year ago)
• Topics: java, lift, ossindex
• Language: Java
• Homepage:
• Size: 4.94 MB
• Stars: 6
• Watchers: 32
• Forks: 10
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          

# Sonatype OSS Index - Public

![license](https://img.shields.io/github/license/sonatype/ossindex-public.svg)

![maven-central](https://img.shields.io/maven-central/v/org.sonatype.ossindex/ossindex-service.svg)

Provides API and clients for [Sonatype OSS Index](https://ossindex.sonatype.org/).

See [Javadocs](https://sonatype.github.io/ossindex-public/) for API and client reference.

## Using the client

To add a dependency on the OSS Index client, use the following:

```xml

  org.sonatype.ossindex

  ossindex-service-client

  1.8.1

```

Two options for transports are provided:

* [HttpUrlConnectionTransport](https://sonatype.github.io/ossindex-public/org/sonatype/ossindex/service/client/transport/HttpUrlConnectionTransport.html) makes use of standard JRE `HttpUrlConnection`

* [HttpClientTransport](https://sonatype.github.io/ossindex-public/org/sonatype/ossindex/service/client/transport/HttpClientTransport.html) makes use of [Apache HttpClient](https://hc.apache.org/httpcomponents-client-ga/)

## Building

### Requirements

* [Apache Maven](https://maven.apache.org/) 3.3+ (prefer to use included `mvnw`)

* JDK 7+ (10 is **NOT** supported)

### Build

    ./mvnw clean install

### Publish the docs

Checkout the release tag first, then:

1. To do a dry run:

        ./mvnw clean javadoc:aggregate scm-publish:publish-scm -Pdocs -Dscmpublish.dryRun=true

1. To publish:

        ./mvnw clean javadoc:aggregate scm-publish:publish-scm -Pdocs