README.md

   1 DCAE SDK
   2 ===============
   3 Because most services and collectors deployed on DCAE platform relies on similar microservices a common Software Development Kit has been created. It contains utilities and clients which may be used when getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK is written in Java.
   4
   5 ## Reactive programming
   6 Most of SDK APIs are using Project Reactor, which is one of available implementations of Reactive Streams (as well as Java 9 Flow). This way we support both high-performance, non-blocking asynchronous clients and old-school, thread-bound, blocking clients. We believe that using reactive programming can solve many cloud-specific problems for us - if used properly.
   7
   8 ## Artifacts
   9
  10 #### Current version
  11 ```
  12 <properties>
  13   <sdk.version>1.1.4</sdk.version>
  14 </properties>
  15 ```
  16 #### Maven dependencies
  17 ```
  18 <dependencies>
  19   <dependency>
  20     <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
  21     <artifactId>cbs-client</artifactId>
  22     <version>${sdk.version}</version>
  23   </dependency>
  24
  25   <dependency>
  26     <groupId>org.onap.dcaegen2.services.sdk.security.crypt</groupId>
  27     <artifactId>crypt-password</artifactId>
  28     <version>${sdk.version}</version>
  29   </dependency>
  30
  31   <dependency>
  32     <groupId>org.onap.dcaegen2.services.sdk</groupId>
  33     <artifactId>hvvesclient-producer-api</artifactId>
  34     <version>${sdk.version}</version>
  35   </dependency>
  36   <dependency>
  37     <groupId>org.onap.dcaegen2.services.sdk</groupId>
  38     <artifactId>hvvesclient-producer-impl</artifactId>
  39     <version>${sdk.version}</version>
  40     <scope>runtime</scope>
  41   </dependency>
  42
  43  <!-- more to go -->
  44
  45 </dependencies>
  46 ```
  47
  48 ## DCAE Common Libraries (ONAP WIKI)
  49 Describes SDK basic features in general.
  50 [DCAE_Common_Libraries](https://wiki.onap.org/pages/viewpage.action?pageId=45300259)
  51
  52 #### DCAE SDK
  53 Contains some general notes about the project and libs which were used in it.
  54 [DCAE_SDK](https://wiki.onap.org/display/DW/DCAE+SDK)
  55
  56 #### Changelog
  57 Provides information about SDK releases and features which are related to them.
  58 [DCAE_SDK_Changelog](https://wiki.onap.org/display/DW/DCAE+SDK+Changelog)
  59
  60 #### FAQ
  61 DCAE SDK Frequently Asked Questions
  62 [FAQ](https://wiki.onap.org/display/DW/DCAE+SDK+Frequently+Asked+Questions)
  63
  64 ## License
  65 Copyright (C) 2018-2019 NOKIA Intellectual Property. All rights reserved.
  66 [License](http://www.apache.org/licenses/LICENSE-2.0)