Package ca.corefacility.bioinformatics.irida.repositories.remote

Interface RemoteRepository<Type extends IridaRepresentationModel>

Type Parameters:

Type - the type of object this repository will store

All Known Subinterfaces:

Fast5ObjectRemoteRepository, GenomeAssemblyRemoteRepository, ProjectRemoteRepository, SampleRemoteRepository, SequenceFilePairRemoteRepository, SequenceFileRemoteRepository, SingleEndSequenceFileRemoteRepository

All Known Implementing Classes:

Fast5ObjectRemoteRepositoryImpl, GenomeAssemblyRemoteRepositoryImpl, ProjectRemoteRepositoryImpl, RemoteRepositoryImpl, SampleRemoteRepositoryImpl, SequenceFilePairRemoteRepositoryImpl, SequenceFileRemoteRepositoryImpl, SingleEndSequenceFileRemoteRepositoryImpl

public interface RemoteRepository<Type extends IridaRepresentationModel>

A repository for storing and retrieving objects from a remote api

Method Summary

Modifier and Type	Method	Description
boolean	getServiceStatus(RemoteAPI remoteAPI)	Get the status of the remote service
java.util.List<Type>	list(java.lang.String uri, RemoteAPI remoteAPI)	List the resources available from this service
Type	read(java.lang.String uri, RemoteAPI remoteAPI)	Read an individual resource

Method Detail

read

Type read(java.lang.String uri,
          RemoteAPI remoteAPI)

Read an individual resource

Parameters:

uri - The URI of the resource to read

remoteAPI - the API to read from

Returns:

An object of Type

list

java.util.List<Type> list(java.lang.String uri,
                          RemoteAPI remoteAPI)

List the resources available from this service

Parameters:

remoteAPI - The API to read from

uri - the URI of the resource to list.

Returns:

A List<Type> of the resources available

getServiceStatus

boolean getServiceStatus(RemoteAPI remoteAPI)
                  throws IridaOAuthException

Get the status of the remote service

Parameters:

remoteAPI - The API to check status for

Returns:

true if the service is active

Throws:

IridaOAuthException - if the service is unavailable