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