Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.61 KB

README.md

File metadata and controls

66 lines (45 loc) · 2.61 KB
Raw

EWP Registry Client

Java implementation of an EWP Registry Service client.

  • When you're implementing a client, it allows you to discover institutions in the network, and APIs implemented by them.

  • When you're implementing a server, it allows to verify incoming requests (prove that they come from within the EWP Network, and prove which institutions the requester covers).

Of course, you are not required to use this client - you can also make use of the Registry API directly. You can also learn more on EWP's architecture here, and get information on all other related tools and specifications here.

Installation and Documentation

Requires at least Java 8 SE. Apart from that, and a tiny SLF4J API library, no other dependencies are required. The resulting JAR is only 49kB in size (as of version 1.8.0).

Releases are deployed to Maven Central Repository. You'll simply need to include a proper reference in your build's dependencies. Click the image below for the artifact details.

Maven Central

You can also browse the project's Javadocs here:

Javadocs

Where to start? We define the RegistryClient interface, and provide a single implementation of this interface called ClientImpl. Please review ClientImpl's javadocs for examples of usage.

Upgrading? Check out the changelog (release notes).

Versioning strategy

We use semantic versioning (MAJOR.MINOR.PATCH) for our release version numbers.

  • Major version is incremented when our changes are likely to break your builds or runtime behavior.

  • Minor version is incremented when new features are added. (Note, that such changes still can break your builds, if you have custom implementations of the RegistryClient interface.)

  • Patch version is incremented on bug fixes, documentation updates, etc.