Package ca.corefacility.bioinformatics.irida.service.remote.impl

Class RemoteServiceImpl<Type extends IridaRepresentationModel & IridaThing>

java.lang.Object

ca.corefacility.bioinformatics.irida.service.remote.impl.RemoteServiceImpl<Type>

Type Parameters:

Type - The type of object to be stored in this repository (extends IridaRepresentationModel)

All Implemented Interfaces:

RemoteService<Type>

Direct Known Subclasses:

GenomeAssemblyRemoteServiceImpl, ProjectRemoteServiceImpl, SampleRemoteServiceImpl, SequencingObjectRemoteServiceImpl

public abstract class RemoteServiceImpl<Type extends IridaRepresentationModel & IridaThing>
extends java.lang.Object
implements RemoteService<Type>

Remote service to request from remote IRIDA instances using OAuth2

Constructor Summary

Constructors

Constructor	Description
RemoteServiceImpl(RemoteRepository<Type> repository, RemoteAPIRepository remoteAPIRepository)	Create a new remote service that interacts with the given repository

Method Summary

Modifier and Type	Method	Description
protected RemoteAPI	getRemoteApiForURI(java.lang.String uri)	Convenience method for getting the RemoteAPI for a given string URI
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)	Read individual resource at the given URI.
Type	read(java.lang.String uri, RemoteAPI remoteAPI)	Read an individual resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteServiceImpl

public RemoteServiceImpl(RemoteRepository<Type> repository,
                         RemoteAPIRepository remoteAPIRepository)

Create a new remote service that interacts with the given repository

Parameters:

repository - The RemoteRepository handling basic operations with the given Type

remoteAPIRepository - repository for storing and retrieving RemoteAPIs

Method Detail

read

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

Read an individual resource

Specified by:

read in interface RemoteService<Type extends IridaRepresentationModel & IridaThing>

Parameters:

uri - The URI of the resource to read

remoteAPI - the API to read from

Returns:

An object of Type

read

public Type read(java.lang.String uri)

Read individual resource at the given URI. The required RemoteAPI will be found using the given resource URI.

Specified by:

read in interface RemoteService<Type extends IridaRepresentationModel & IridaThing>

Parameters:

uri - The URI of the resource

Returns:

an object of Type

list

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

List the resources available from this service

Specified by:

list in interface RemoteService<Type extends IridaRepresentationModel & IridaThing>

Parameters:

uri - the uri to load the resources from.

remoteAPI - The API to read from

Returns:

A List<Type> of the resources available

getServiceStatus

public boolean getServiceStatus(RemoteAPI remoteAPI)

Get the status of the remote service

Specified by:

getServiceStatus in interface RemoteService<Type extends IridaRepresentationModel & IridaThing>

Parameters:

remoteAPI - The API to check status for

Returns:

true if the service is active

getRemoteApiForURI

protected RemoteAPI getRemoteApiForURI(java.lang.String uri)

Convenience method for getting the RemoteAPI for a given string URI

Parameters:

uri - the URI to get a RemoteAPI for

Returns:

the RemoteAPI