Package io.wcm.caravan.hal.comparison
Interface HalComparisonSource
-
@ConsumerType public interface HalComparisonSource
Defines where the input data for theHalComparison
service is located and how it is retrieved.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getEntryPointUrl()
Defines the URL of the HAL+JSON resource from where the comparison is started.rx.Single<io.wcm.caravan.hal.resource.HalResource>
resolveLink(String url)
Load the HAL+JSON resource from the given URL.
-
-
-
Method Detail
-
getEntryPointUrl
String getEntryPointUrl()
Defines the URL of the HAL+JSON resource from where the comparison is started.- Returns:
- an absolute URI or path (depending on the implementation of
resolveLink(String)
-
resolveLink
rx.Single<io.wcm.caravan.hal.resource.HalResource> resolveLink(String url)
Load the HAL+JSON resource from the given URL.- Parameters:
url
- an absolute URI or path (depending on how the links are represented in the resources being compared)- Returns:
- a
Single
that emits theHalResource
when it is retrieved (or throws any Exception when it could not be loaded)
-
-