Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-distribution-client / refs/heads/master
commit09a9061fb4eef8a7b54fb35ae9391837939ea155[log] [tgz]
authorMichaelMorris <michael.morris@est.tech>Fri Oct 27 11:41:00 2023 +0100
committerMichael Morris <michael.morris@est.tech>Fri Oct 27 11:15:04 2023 +0000
treea8ebbb1034494eb7c86aa96b9c865b1db237c33e
parent652fa3b4a77c8e01d665d2078d85ce7e374f1ce2 [diff]
Release 2.1.1

Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-4672
Change-Id: If37c2d2e36d587c430f3ce42b0a76e4979f08484
1 file changed
tree: a8ebbb1034494eb7c86aa96b9c865b1db237c33e
  1. docs/
  2. releases/
  3. sdc-distribution-ci/
  4. sdc-distribution-client/
  5. .gitignore
  6. .gitreview
  7. .readthedocs.yaml
  8. Changelog.md
  9. checkstyle-suppressions.xml
  10. INFO.yaml
  11. LICENSE.TXT
  12. lombok.config
  13. pom.xml
  14. README.md
  15. version.properties
README.md

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://wiki.onap.org/display/DW/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:

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 ***