CRUK-CI Clarity API Client 2.31.7 API
This project is the Cambridge Research UK Cambridge Institute (CRUK-CI) Java client for Clarity's REST API.
It wraps a REST client to allow Java objects to be used for working with the Clarity system. The object to XML translations are handled automatically, as are the HTTP exchanges. It requires the Spring framework and uses many of its features.
The model classes were originally generated from Genologics' XSD schema documents. They are embellished with interfaces to distinguish between the actual entities and the links to those entities. The classes as presented here should allow users of this client to work with the Clarity API with minimal overhead.
The XSD files are packaged with this project: all rights to these belong to Genologics (now Illumina).
To use the client, create a Spring application context including the file
org/cruk/clarity/api/clarity-client-context.xml, from which
you can obtain the bean "clarityAPI". If you wish to use the
caching facility, also add the file
org/cruk/clarity/api/clarity-cache-context.xml to the
application context path.