summaryrefslogtreecommitdiffstats
path: root/README.md
blob: b94de89fb7b78e24ecea0b2a27075f4f57567545 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
DCAE SDK
===============
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.

## Reactive programming
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.

## Artifacts

#### Current version
```
<properties>
  <sdk.version>1.1.4</sdk.version>
</properties>
```
#### Maven dependencies
```
<dependencies>
  <dependency>
    <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
    <artifactId>cbs-client</artifactId>
    <version>${sdk.version}</version>
  </dependency>
 
  <dependency>
    <groupId>org.onap.dcaegen2.services.sdk.security.crypt</groupId>
    <artifactId>crypt-password</artifactId>
    <version>${sdk.version}</version>
  </dependency>
 
  <dependency>
    <groupId>org.onap.dcaegen2.services.sdk</groupId>
    <artifactId>hvvesclient-producer-api</artifactId>
    <version>${sdk.version}</version>
  </dependency>
  <dependency>
    <groupId>org.onap.dcaegen2.services.sdk</groupId>
    <artifactId>hvvesclient-producer-impl</artifactId>
    <version>${sdk.version}</version>
    <scope>runtime</scope>
  </dependency>
 
 <!-- more to go -->
 
</dependencies>
```

## DCAE Common Libraries (ONAP WIKI) 
Describes SDK basic features in general.
[DCAE_Common_Libraries](https://wiki.onap.org/pages/viewpage.action?pageId=45300259)

#### DCAE SDK 
Contains some general notes about the project and libs which were used in it.
[DCAE_SDK](https://wiki.onap.org/display/DW/DCAE+SDK)

#### Changelog
Provides information about SDK releases and features which are related to them.
[DCAE_SDK_Changelog](https://wiki.onap.org/display/DW/DCAE+SDK+Changelog)

#### FAQ
DCAE SDK Frequently Asked Questions 
[FAQ](https://wiki.onap.org/display/DW/DCAE+SDK+Frequently+Asked+Questions)

## License
Copyright (C) 2018-2019 NOKIA Intellectual Property. All rights reserved.
[License](http://www.apache.org/licenses/LICENSE-2.0)