aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 03243ca995339ba90a8a51f9990ad8bd66249e2e (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
# ONAP SDC Distribution client

---
---

## Introduction

ONAP SDC Distribution client is delivered as helper JAR that can be used by clients that work with SDC.
It listens for notifications from SDC, download artifacts from SDC, and send response back to SDC.

## Compiling ONAP SDC Distribution client

As mentioned in the [onap wiki](https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16220206/Setting+Up+Your+Development+Environment),
the [settings.xml](https://git.onap.org/oparent/plain/settings.xml) from the oparent project must be
installed in your ~/.m2 folder and referenced by your IDE.

Once maven is set up properly, ONAP SDC Distribution client can be compiled easily using maven command: `mvn clean install`
The result is JAR file under "target" folder


### How to use ONAP SDC Distribution client

Every client that wants to use the JAR, need to implement IConfiguration interface.

See the SDC ONAP read the docs for more detail in relation to the sdc-distribution-client usage.
https://docs.onap.org/projects/onap-sdc/en/kohn/sdcsdks.html#sdc-tosca-and-sdc-distribution-client

## Logging

Loggin can be done using log4j
Example of log.properties file:
```ini
-------------------------------
log4j.rootCategory=DEBUG, CONSOLE, LOGFILE
log4j.logger.org.onap=TRACE, CONSOLE, LOGFILE

# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%p %d{yyyy-MM-dd HH:mm:ss.SSS Z} %c{1} - %m%n

# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.RollingFileAppender
log4j.appender.LOGFILE.File=logs/wordnik.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%p %d{yyyy-MM-dd HH:mm:ss.SSS Z} %c{1} - %m%n
log4j.appender.LOGFILE.MaxFileSize=10MB
log4j.appender.LOGFILE.MaxBackupIndex=10
```

## Getting Help

*** to be completed on release ***

SDC@lists.onap.org

SDC Javadoc and Maven site

*** to be completed on rrelease ***