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