Changelog.md

   1 # Change Log
   2 All notable changes to this project will be documented in this file.
   3
   4 The format is based on [Keep a Changelog](http://keepachangelog.com/)
   5 and this project adheres to [Semantic Versioning](http://semver.org/).
   6
   7 ## [1.8.5] - 02/06/2021
   8 ### Added
   9     - [DCAEGEN2-2752] (https://jira.onap.org/browse/DCAEGEN2-2752) - Update CBS-Client to read policy configuration from a file exposed by policy-sidecar container
  10
  11 ## [1.8.4] - 14/05/2021
  12 ### Added
  13     - [DCAEGEN2-2716] (https://jira.onap.org/browse/DCAEGEN2-2716) - Add to Java CBS-Client ability to resolve evns in app-config.yaml loaded from ConfigMap
  14
  15 ## [1.8.3] - 29/04/2021
  16 ### Added
  17     - [DCAEGEN2-2716] (https://jira.onap.org/browse/DCAEGEN2-2716) - Adapt CBS-CLient to read configuration from a file exposed in a cfgMap
  18
  19 ## [1.8.2] - 30/03/2021
  20 ### Added
  21     - [DCAEGEN2-2701] (https://jira.onap.org/browse/DCAEGEN2-2701) - Add stndDefinedNamespace field to CommonEventHeader
  22
  23 ## [1.8.1] - 25/03/2021
  24 ### Fixed
  25     - [DCAEGEN2-2670] (https://jira.onap.org/browse/DCAEGEN2-2670) - Support authorized topics in DMaaP-Client
  26         - Remove test dependencies usage from runtime code
  27
  28 ## [1.8.0] - 10/03/2021
  29 ### Added
  30     - [DCAEGEN2-2670] (https://jira.onap.org/browse/DCAEGEN2-2670) - Support authorized topics in DMaaP-Client
  31
  32 ## [1.7.0] - 25/02/2021
  33 ### Added
  34     - [DCAEGEN2-1483] (https://jira.onap.org/browse/DCAEGEN2-1483) - VESCollector Event ordering
  35         - Add possibility to modify the configuration for persistent connection
  36         - Support retry-after header in DCAE-SDK DMaaP-Client
  37
  38 ## [1.6.0] ##
  39     - Add configurable timeout in dmaap-client
  40     - Add configurable retry mechanism in dmaap-client
  41
  42 ## [1.5.0] ##
  43     - Update spring boot to version: 2.4.0
  44     - Update reactor to version: 2020.0.1
  45     - Update testcontainers to version: 1.15.0
  46
  47 ## [1.4.4] ##
  48     - Fix CbsClientFactory to allow retry on Mono from createCbsClient
  49
  50 ## [1.4.3] ##
  51     - Change parameters of external-schema-manager to JSON notation
  52
  53 ## [1.4.2] ##
  54     - Update spring boot to version: 2.3.3.RELEASE
  55
  56 ## [1.4.1] ##
  57     - Update spring boot to version: 2.2.9.RELEASE
  58     - Update testcontainers version:  1.14.3
  59     - Fix deprecation warnings
  60
  61 ## [1.4.0] ##
  62     - Add new component external-schema-manager for json validation with schema stored in local cache
  63
  64 ## [1.3.5] ##
  65     - Create jar without dependencies for crypt-password module
  66
  67 ## [1.3.4] ##
  68     - Usage of Java 11
  69
  70 ## [1.3.3] ##
  71     - Upgrade CBS to support SSL
  72     - Fix static code vulnerabilities
  73     - Exclude IT from tests
  74     - Remove AAI client from SDK
  75
  76 ## [1.3.2] ##
  77     - Restructure AAI client
  78     - Get rid of common-dependency module
  79     - Rearrange files in packages inside rest-services
  80
  81 ## [1.3.1] ##
  82     - Bugfix release: AAI client
  83         - Make AaiGetServiceInstanceClient build correct path to the service resource in AAI
  84
  85 ## [1.3.0] (ElAlto - under development) ##
  86     - All El-Alto work noted under 1.2.0-SNAPSHOT will roll into this version
  87     - Version update was done for tracking global-jjb migration work and corresponding submission - https://gerrit.onap.org/r/#/c/dcaegen2/services/sdk/+/89902/
  88
  89 ## [1.2.0] (replaced by 1.3.0) ##
  90     - WARNING: This is a work in progress. Do not use unless you know what you are doing!
  91
  92     - DMaaP client
  93         - Change the factory so it's more configurable
  94         - Old DMaaP client is now deprecated
  95         - Integration tests are now using TestContainers with an actual DMaaP in order to confirm compatibility with a particular DMaaP version.
  96         - Breaking change: MessageRouterSubscribeResponse now contains list of JsonElement instead of JsonArray
  97     - CBS client
  98         - Use new, simplified CBS lookup method
  99         - Breaking change: CbsClientConfiguration replaces old EnvProperties. This way the class reflects overall SDK naming convention.
 100     - Crypt Password
 101         - Additional command line usage options (read password from stdin)
 102         - Enhanced test coverage
 103     - Internals/others
 104         - Remove CloudHttpClient and use RxHttpClient instead which should unify REST API consumption across client libraries
 105     - Moher (MOnitoring and HEalthcheck Rest API)
 106         - This API is in incubation stage. Do not use it yet.
 107         - Initial PoC for new module which should help when implementing these features in a DCAE service
 108         - Expose Prometheus-compliant monitoring endpoint
 109
 110 ## [1.1.6] ##
 111     - Bugfix release: (Old) DMaaP client:
 112         - Security keys was always loaded from JAR instead of given file system path. Only code using SecurityKeysUtil class had been affected. If you do not use SecurityKeysUtil class or you are using the new DMaaP MR client API (org.onap.dcaegen2.services.sdk.rest.services.dmaap.client.{api, model} packages) then you are safe and the update is not required.
 113
 114 ## [1.1.5] ##
 115     - DMaaP client
 116         - Force non-chunked transfer encoding, because DMaaP MR does not support chunks.
 117         - DMaaP MR client API should be used in new code. Some minor incompatible changes can occur but it's more or less done.
 118
 119 ## [1.1.4] ##
 120     - Config Binding Service client
 121         - predefined parsers for input and output streams
 122             - remove the need for a DCAE application to manually interpret streams_publishes (Sinks) and streams_subscribes (Sources) parts of the configuration
 123             - available parsers for DMaaP Message Router and DMaaP Data Router streams
 124             - experimental support for Kafka streams
 125         - support for other CBS endpoints besides get-configuration: get-by-key, get-all (introduces minor but breaking changes)
 126     - DMaaP client
 127         - New, experimental DMaaP client. It's not ready for use yet (not integration tested with DMaaP instance). However, you can use this API if you target El Alto release (note that some minor interface changes might be introduced).
 128     - Internals:
 129         - Improved http client: RxHttpClient
 130         - RxHttpClient uses chunked transfer-encoding only when content-length is NOT specified.
 131
 132 Migration guide
 133
 134 All CbsClient methods gets CbsRequest as a first parameter instead of RequestDiagnosticContext. The CbsRequest may be created by calling CbsRequests factory methods. For existing code to work you will need to do the following change:
 135
 136 .. code-block:: java
 137
 138     // From this:
 139     CbsClientFactory.createCbsClient(env)
 140         .flatMap(cbsClient -> cbsClient.get(diagnosticContext))
 141         ...
 142
 143     // To this:
 144     final CbsRequest request = CbsRequests.getConfiguration(diagnosticContext);
 145     CbsClientFactory.createCbsClient(env)
 146         .flatMap(cbsClient -> cbsClient.get(request))
 147         ...
 148
 149 The similar changes will be required for other CbsClient methods (periodic get and periodic updates).
 150
 151 ## [1.1.3] (initial release) ##
 152     - Config Binding Service client
 153         - basic functionality
 154         - CBS service discovery
 155         - get application configuration as JsonObject
 156         - periodic query + periodic updates query
 157     - BCrypt password utility