README.md

Pinery Client (Java)

This is a Java client for accessing the Pinery API. Pinery is a read-only REST webservice for retrieving LIMS data. The client makes available all REST endpoints provided by Pinery.

Usage

After importing the client into your code, usage as as simple as creating a PineryClient that points to a Pinery webservice URL, and making requests.

1. Instantiate a PineryClient object:

    PineryClient pinery = new PineryClient("http://localhost:8888/pinery-ws");
   

2. Get resources. The example below demonstrates the types of calls available and the patterns they follow. See the javadocs for more information regarding specific classes.

    // Full list
    List<SampleDto> sampleList = pinery.getSample().all();
    
    // Single field filter
    SampleDto sample = pinery.getSample().byId(22);
    
    // Multiple field filter
    List<SampleDto> filteredSampleList = pinery.getSample().allFiltered(
        new SamplesFilter()
            .withArchived(false)
            .withDateBefore(myDateTime);
    );
   

3. Remember to close the PineryClient when it is no longer needed.

    pinery.close();
   

Support

For support, please file an issue on the Github project or send an email to gsi@oicr.on.ca .