eu.erasmuswithoutpaper.registryclient

Class DefaultCatalogueFetcher

java.lang.Object

eu.erasmuswithoutpaper.registryclient.DefaultCatalogueFetcher

All Implemented Interfaces:

CatalogueFetcher

public class DefaultCatalogueFetcher
extends Object
implements CatalogueFetcher

A CatalogueFetcher which retrieves its <catalogue> response directly from the Registry Service.

This default implementation will be used by the ClientImpl unless a custom implementation will be set via ClientImplOptions.setCatalogueFetcher(CatalogueFetcher) method.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface eu.erasmuswithoutpaper.registryclient.CatalogueFetcher

CatalogueFetcher.Http200RegistryResponse, CatalogueFetcher.Http304RegistryResponse, CatalogueFetcher.RegistryResponse

Constructor Summary

Constructors

Constructor and Description
DefaultCatalogueFetcher() Initialize with the default (official) Registry Service ( registry.erasmuswithoutpaper.eu).
DefaultCatalogueFetcher(String customRegistryDomain) Allows you to use an alternate installation of the Registry Service.

Method Summary

Modifier and Type	Method and Description
CatalogueFetcher.RegistryResponse	fetchCatalogue(String previousETag) Fetch the catalogue from the Registry Service, or confirm that it didn't change.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCatalogueFetcher

public DefaultCatalogueFetcher()

Initialize with the default (official) Registry Service ( registry.erasmuswithoutpaper.eu).

DefaultCatalogueFetcher

public DefaultCatalogueFetcher(String customRegistryDomain)

Allows you to use an alternate installation of the Registry Service.

In particular, during the development you might want to use dev-registry.erasmuswithoutpaper.eu.

Parameters:

customRegistryDomain - domain name at which an alternate Registry Service installation has been set up.

Since:

1.1.0

Method Detail

fetchCatalogue

public CatalogueFetcher.RegistryResponse fetchCatalogue(String previousETag)
                                                 throws IOException

Description copied from interface: CatalogueFetcher

Fetch the catalogue from the Registry Service, or confirm that it didn't change.

Implementations are strongly advised to include the attached ETag value in their If-None-Match HTTP header when making the request to the Registry API. ClientImpl is interested in just two types of Registry API responses:

• If HTTP 200 is received, then this method must return an CatalogueFetcher.Http200RegistryResponse object.
• If HTTP 304 is received, then this method must return an CatalogueFetcher.Http304RegistryResponse object.
• If any other type of response is received from the Registry API, or the Registry API cannot be contacted, then this method must throw an IOException.

Specified by:

fetchCatalogue in interface CatalogueFetcher

Parameters:

previousETag - String or null. If not null, then it should contain the ETag value to be used in the If-None-Match request header (the ETag representing the version of the catalogue which we currently possess). If null, then this method will not use the If-None-Match header (and will therefore be expected to return an CatalogueFetcher.Http200RegistryResponse).

Returns:

Either CatalogueFetcher.Http200RegistryResponse or CatalogueFetcher.Http304RegistryResponse object.

Throws:

IOException - if Registry API could not be contacted, or it has responded with a HTTP status different than 200 and 304.