-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
246 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
184 changes: 184 additions & 0 deletions
184
sdmx-dl-provider-ri/src/main/java/internal/sdmxdl/ri/web/drivers/BbkDriver.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| /* | ||
| * Copyright 2017 National Bank of Belgium | ||
| * | ||
| * Licensed under the EUPL, Version 1.1 or - as soon they will be approved | ||
| * by the European Commission - subsequent versions of the EUPL (the "Licence"); | ||
| * You may not use this work except in compliance with the Licence. | ||
| * You may obtain a copy of the Licence at: | ||
| * | ||
| * http://ec.europa.eu/idabc/eupl | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the Licence is distributed on an "AS IS" basis, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the Licence for the specific language governing permissions and | ||
| * limitations under the Licence. | ||
| */ | ||
| package internal.sdmxdl.ri.web.drivers; | ||
|
|
||
| import internal.sdmxdl.ri.web.RestClients; | ||
| import internal.sdmxdl.ri.web.Sdmx21RestClient; | ||
| import internal.sdmxdl.ri.web.Sdmx21RestQueries; | ||
| import internal.sdmxdl.ri.web.SdmxResourceType; | ||
| import internal.util.rest.HttpRest; | ||
| import internal.util.rest.RestQueryBuilder; | ||
| import nbbrd.io.text.Parser; | ||
| import nbbrd.service.ServiceProvider; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
| import sdmxdl.*; | ||
| import sdmxdl.ext.ObsFactory; | ||
| import sdmxdl.ext.ObsParser; | ||
| import sdmxdl.util.SdmxFix; | ||
| import sdmxdl.util.parser.DefaultObsParser; | ||
| import sdmxdl.util.parser.FreqFactory; | ||
| import sdmxdl.util.parser.PeriodParsers; | ||
| import sdmxdl.util.web.DataRequest; | ||
| import sdmxdl.util.web.SdmxWebClient; | ||
| import sdmxdl.util.web.SdmxWebDriverSupport; | ||
| import sdmxdl.web.SdmxWebSource; | ||
| import sdmxdl.web.spi.SdmxWebContext; | ||
| import sdmxdl.web.spi.SdmxWebDriver; | ||
| import sdmxdl.xml.stream.SdmxXmlStreams; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.URL; | ||
| import java.util.*; | ||
|
|
||
| import static sdmxdl.ext.SdmxMediaType.GENERIC_DATA_21; | ||
| import static sdmxdl.util.SdmxFix.Category.QUERY; | ||
|
|
||
| /** | ||
| * @author Philippe Charles | ||
| */ | ||
| @ServiceProvider(SdmxWebDriver.class) | ||
| public final class BbkDriver implements SdmxWebDriver { | ||
|
|
||
| private static final String RI_BBK = "ri:bbk"; | ||
|
|
||
| @lombok.experimental.Delegate | ||
| private final SdmxWebDriverSupport support = SdmxWebDriverSupport | ||
| .builder() | ||
| .name(RI_BBK) | ||
| .rank(NATIVE_RANK) | ||
| .client(BbkDriver::of) | ||
| .supportedProperties(RestClients.CONNECTION_PROPERTIES) | ||
| .source(SdmxWebSource | ||
| .builder() | ||
| .name("BBK") | ||
| .description("Bundesbank") | ||
| .driver(RI_BBK) | ||
| .endpointOf("https://api.statistiken.bundesbank.de/rest") | ||
| .websiteOf("https://www.bundesbank.de/en/statistics/time-series-databases") | ||
| .monitorOf("UptimeRobot", "m788346159-bf4da8fbc0d9c633266a9387") | ||
| .build()) | ||
| .build(); | ||
|
|
||
| private static SdmxWebClient of(SdmxWebSource s, SdmxWebContext c) throws IOException { | ||
| return new BbkClient( | ||
| SdmxWebClient.getClientName(s), | ||
| s.getEndpoint(), | ||
| c.getLanguages(), | ||
| RestClients.getRestClient(s, c) | ||
| ); | ||
| } | ||
|
|
||
| // FIXME: add support of multiple mediaTypes in HTTP requests | ||
| private static final class BbkClient extends Sdmx21RestClient { | ||
|
|
||
| private BbkClient(String name, URL endpoint, LanguagePriorityList langs, HttpRest.Client executor) { | ||
| super(name, endpoint, langs, executor, true, BbkQueries.INSTANCE, BbkObsFactory.INSTANCE); | ||
| } | ||
|
|
||
| @Override | ||
| public DataCursor getData(DataRequest request, DataStructure dsd) throws IOException { | ||
| if (request.getKey().equals(Key.ALL)) { | ||
| request = request.toBuilder().key(alternateAllOf(dsd)).build(); | ||
| } | ||
| return super.getData(request, dsd); | ||
| } | ||
|
|
||
| @SdmxFix(id = 6, category = QUERY, cause = "Data key parameter does not support 'all' keyword") | ||
| private Key alternateAllOf(DataStructure dsd) { | ||
| return Key.of(new String[dsd.getDimensions().size()]); | ||
| } | ||
|
|
||
| @Override | ||
| protected DataCursor getData(DataStructure dsd, URL url) throws IOException { | ||
| return SdmxXmlStreams | ||
| .genericData21(dsd, dataFactory) | ||
| .parseStream(calling(url, GENERIC_DATA_21)); | ||
| } | ||
| } | ||
|
|
||
| private static final class BbkQueries extends Sdmx21RestQueries { | ||
|
|
||
| private static final BbkQueries INSTANCE = new BbkQueries(); | ||
|
|
||
| private BbkQueries() { | ||
| super(false, getCustomResources()); | ||
| } | ||
|
|
||
| @SdmxFix(id = 1, category = QUERY, cause = "Meta uses custom resources path") | ||
| private static Map<SdmxResourceType, List<String>> getCustomResources() { | ||
| HashMap<SdmxResourceType, List<String>> result = new HashMap<>(); | ||
| result.put(SdmxResourceType.DATAFLOW, Arrays.asList("metadata", "dataflow")); | ||
| result.put(SdmxResourceType.DATASTRUCTURE, Arrays.asList("metadata", "datastructure")); | ||
| return result; | ||
| } | ||
|
|
||
| @SdmxFix(id = 2, category = QUERY, cause = "Resource ref does not support 'all' in agencyID") | ||
| private static final String AGENCY_ID = "BBK"; | ||
|
|
||
| @SdmxFix(id = 3, category = QUERY, cause = "Resource ref does not support 'all' in resourceID") | ||
| private static boolean isValid(ResourceRef<?> ref) { | ||
| return !ref.getId().equals("all"); | ||
| } | ||
|
|
||
| @Override | ||
| protected RestQueryBuilder onMeta(URL endpoint, SdmxResourceType resource, ResourceRef<?> ref) { | ||
| RestQueryBuilder result = RestQueryBuilder | ||
| .of(endpoint) | ||
| .path(getResource(resource)) | ||
| .path(AGENCY_ID); | ||
| if (isValid(ref)) { | ||
| result.path(ref.getId()); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| @SdmxFix(id = 4, category = QUERY, cause = "Data does not support providerRef") | ||
| @Override | ||
| protected RestQueryBuilder onData(URL endpoint, SdmxResourceType resource, DataflowRef flowRef, Key key, String providerRef) { | ||
| return RestQueryBuilder | ||
| .of(endpoint) | ||
| .path(getResource(resource)) | ||
| .path(flowRef.getId()) | ||
| .path(key.toString()); | ||
| } | ||
|
|
||
| @SdmxFix(id = 5, category = QUERY, cause = "Data detail parameter for series-keys-only has a typo") | ||
| @Override | ||
| protected void applyFilter(DataFilter filter, RestQueryBuilder result) { | ||
| if (filter.getDetail().equals(DataFilter.Detail.SERIES_KEYS_ONLY)) { | ||
| result.param(DETAIL_PARAM, "serieskeyonly"); | ||
| } else { | ||
| super.applyFilter(filter, result); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // FIXME: use TIME_FORMAT attribute instead of FREQ dimension in SDMX21 ? | ||
| private enum BbkObsFactory implements ObsFactory { | ||
| INSTANCE; | ||
|
|
||
| @Override | ||
| public @NonNull ObsParser getObsParser(@NonNull DataStructure dsd) { | ||
| Objects.requireNonNull(dsd); | ||
| return new DefaultObsParser( | ||
| FreqFactory.sdmx20(dsd), | ||
| PeriodParsers::onStandardFreq, | ||
| Parser.onDouble() | ||
| ); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
sdmx-dl-provider-ri/src/test/java/internal/sdmxdl/ri/web/drivers/BbkDriverTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Copyright 2018 National Bank of Belgium | ||
| * | ||
| * Licensed under the EUPL, Version 1.1 or - as soon they will be approved | ||
| * by the European Commission - subsequent versions of the EUPL (the "Licence"); | ||
| * You may not use this work except in compliance with the Licence. | ||
| * You may obtain a copy of the Licence at: | ||
| * | ||
| * http://ec.europa.eu/idabc/eupl | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the Licence is distributed on an "AS IS" basis, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the Licence for the specific language governing permissions and | ||
| * limitations under the Licence. | ||
| */ | ||
| package internal.sdmxdl.ri.web.drivers; | ||
|
|
||
| import org.junit.Test; | ||
| import sdmxdl.tck.web.SdmxWebDriverAssert; | ||
|
|
||
| /** | ||
| * @author Philippe Charles | ||
| */ | ||
| public class BbkDriverTest { | ||
|
|
||
| @Test | ||
| public void testCompliance() { | ||
| SdmxWebDriverAssert.assertCompliance(new BbkDriver()); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters