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