workiva / eva-client-java

Java library for interacting with the eva-client-service.

Eva Client Java

• Overview
  • Environment Variables
    • EVA_SANITIZE_EXCEPTIONS
• Maintainers and Contributors
  • Active Maintainers
  • Previous Contributors

Overview

This library provides an easy way to interact with the Eva Client Service.

This library should closely resemble Eva's API. If you are already familiar with Eva you should be able to quickly get going.

You can view language specific readmes here:

• Eva Client Java via Java
• Eva Client Java via Clojure

Environment Variables

EVA_SANITIZE_EXCEPTIONS

By default, this library sanitizes exceptions that it gets back from the client service. These exceptions can be logged. To change whether or not your exceptions are sanitized, you can set the EVA_SANITIZE_EXCEPTIONS environment variable to false.
When exceptions are sanitized the message is removed and the getData() method will return an empty map.

It should be noted that EvaExceptions have a getUnsanitized() method, that will allow you to get the original exception before it was sanitized.

For more information and examples on working with EvaExceptions check out the following document:

Maintainers and Contributors

Active Maintainers

• Daniel Harasymiw [email protected]

Previous Contributors

• Daniel Harasymiw [email protected]
• Tyler Wilding [email protected]

eva-client-java's Issues

Add a health check method for checking the status of the client-service

The client-service has endpoints to verify it's health, the java-client should be able to hit these.

Add to-tx-num inline function

Once this is added to the client-service it should be added here. This will allow us to eventually remove the direct dependency on the EVA client library.

Support transactions of maps

It's planned / already been implemented that EVA supports the transaction of maps instead of just vectors. Therefore the java-client must also support this feature

Mocked unit-tests can be flakey at times

There is something amiss with the mocked unit-tests that causes the tests to intermittently fail. This is more than likely because the mocked object is not properly being cleaned up and the wrong response is being returned.

ORM Style functionality

It would be awesome if one could construct a query/transaction/pull/etc without direct knowledge in datalog. Therefore there has to be some sort of ORM style layer inbetween that could be used in the majority of simple use-cases, with raw datalog as a fall-back option.

Add to-tx-eid inline function

Once this is added to the client-service it should be added here. This will allow us to eventually remove the direct dependency on the EVA client library.

Query syntax builder

It would be nice to have a more comprehensive builder pattern for building queries. Methods for defining the various clauses, etc.