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.7.0] - 10/02/2021
   8 ### Added
   9     - [DCAEGEN2-1483] (https://jira.onap.org/browse/DCAEGEN2-1483) - VESCollector Event ordering
  10         - Add possibility to modify the configuration for persistent connection
  11
  12 ## [1.6.0] ##
  13     - Add configurable timeout in dmaap-client
  14     - Add configurable retry mechanism in dmaap-client
  15
  16 ## [1.5.0] ##
  17     - Update spring boot to version: 2.4.0
  18     - Update reactor to version: 2020.0.1
  19     - Update testcontainers to version: 1.15.0
  20
  21 ## [1.4.4] ##
  22     - Fix CbsClientFactory to allow retry on Mono from createCbsClient
  23
  24 ## [1.4.3] ##
  25     - Change parameters of external-schema-manager to JSON notation
  26
  27 ## [1.4.2] ##
  28     - Update spring boot to version: 2.3.3.RELEASE
  29
  30 ## [1.4.1] ##
  31     - Update spring boot to version: 2.2.9.RELEASE
  32     - Update testcontainers version:  1.14.3
  33     - Fix deprecation warnings
  34
  35 ## [1.4.0] ##
  36     - Add new component external-schema-manager for json validation with schema stored in local cache
  37
  38 ## [1.3.5] ##
  39     - Create jar without dependencies for crypt-password module
  40
  41 ## [1.3.4] ##
  42     - Usage of Java 11
  43
  44 ## [1.3.3] ##
  45     - Upgrade CBS to support SSL
  46     - Fix static code vulnerabilities
  47     - Exclude IT from tests
  48     - Remove AAI client from SDK
  49
  50 ## [1.3.2] ##
  51     - Restructure AAI client
  52     - Get rid of common-dependency module
  53     - Rearrange files in packages inside rest-services
  54
  55 ## [1.3.1] ##
  56     - Bugfix release: AAI client
  57         - Make AaiGetServiceInstanceClient build correct path to the service resource in AAI
  58
  59 ## [1.3.0] (ElAlto - under development) ##
  60     - All El-Alto work noted under 1.2.0-SNAPSHOT will roll into this version
  61     - Version update was done for tracking global-jjb migration work and corresponding submission - https://gerrit.onap.org/r/#/c/dcaegen2/services/sdk/+/89902/
  62
  63 ## [1.2.0] (replaced by 1.3.0) ##
  64     - WARNING: This is a work in progress. Do not use unless you know what you are doing!
  65
  66     - DMaaP client
  67         - Change the factory so it's more configurable
  68         - Old DMaaP client is now deprecated
  69         - Integration tests are now using TestContainers with an actual DMaaP in order to confirm compatibility with a particular DMaaP version.
  70         - Breaking change: MessageRouterSubscribeResponse now contains list of JsonElement instead of JsonArray
  71     - CBS client
  72         - Use new, simplified CBS lookup method
  73         - Breaking change: CbsClientConfiguration replaces old EnvProperties. This way the class reflects overall SDK naming convention.
  74     - Crypt Password
  75         - Additional command line usage options (read password from stdin)
  76         - Enhanced test coverage
  77     - Internals/others
  78         - Remove CloudHttpClient and use RxHttpClient instead which should unify REST API consumption across client libraries
  79     - Moher (MOnitoring and HEalthcheck Rest API)
  80         - This API is in incubation stage. Do not use it yet.
  81         - Initial PoC for new module which should help when implementing these features in a DCAE service
  82         - Expose Prometheus-compliant monitoring endpoint
  83
  84 ## [1.1.6] ##
  85     - Bugfix release: (Old) DMaaP client:
  86         - 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.
  87
  88 ## [1.1.5] ##
  89     - DMaaP client
  90         - Force non-chunked transfer encoding, because DMaaP MR does not support chunks.
  91         - DMaaP MR client API should be used in new code. Some minor incompatible changes can occur but it's more or less done.
  92
  93 ## [1.1.4] ##
  94     - Config Binding Service client
  95         - predefined parsers for input and output streams
  96             - remove the need for a DCAE application to manually interpret streams_publishes (Sinks) and streams_subscribes (Sources) parts of the configuration
  97             - available parsers for DMaaP Message Router and DMaaP Data Router streams
  98             - experimental support for Kafka streams
  99         - support for other CBS endpoints besides get-configuration: get-by-key, get-all (introduces minor but breaking changes)
 100     - DMaaP client
 101         - 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).
 102     - Internals:
 103         - Improved http client: RxHttpClient
 104         - RxHttpClient uses chunked transfer-encoding only when content-length is NOT specified.
 105
 106 Migration guide
 107
 108 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:
 109
 110 .. code-block:: java
 111
 112     // From this:
 113     CbsClientFactory.createCbsClient(env)
 114         .flatMap(cbsClient -> cbsClient.get(diagnosticContext))
 115         ...
 116
 117     // To this:
 118     final CbsRequest request = CbsRequests.getConfiguration(diagnosticContext);
 119     CbsClientFactory.createCbsClient(env)
 120         .flatMap(cbsClient -> cbsClient.get(request))
 121         ...
 122
 123 The similar changes will be required for other CbsClient methods (periodic get and periodic updates).
 124
 125 ## [1.1.3] (initial release) ##
 126     - Config Binding Service client
 127         - basic functionality
 128         - CBS service discovery
 129         - get application configuration as JsonObject
 130         - periodic query + periodic updates query
 131     - BCrypt password utility