common/readMe.txt

   1 # OpenECOMP Common
   2
   3 ---
   4 ---
   5
   6 # Introduction
   7
   8 ASDC is required to distribute the Service Definition model to different systems of the OPENECOMP platform. The systems interested in the Service model will subscribe to Artifact Generator. Artifact Generator is responsible for converting its internal Service definition model to the data model required by the different subscribing systems.
   9
  10 In 1707, Artifact Generator will generate artifacts only for A&AI.
  11
  12 # Compiling Common
  13
  14 ###Common can be compiled easily with a `mvn clean install` at the following locations :
  15
  16 #### common\openecomp-sdc-artifact-generator-lib
  17 #### common\openecomp-logging-lib
  18
  19 ### For artifact generator, the resultant jar files are located at :
  20
  21 #### common\openecomp-sdc-artifact-generator-lib\openecomp-sdc-artifact-generator-api\target
  22 #### common\openecomp-sdc-artifact-generator-lib\openecomp-sdc-artifact-generator-core\target
  23
  24 ### For openecomp-logging, the resultant jar files are located at :
  25
  26 #### common\openecomp-logging-lib\openecomp-logging-api\target
  27 #### common\openecomp-logging-lib\openecomp-logging-core\target
  28
  29 ### For configuration-management, the resultant jar files are located at :
  30
  31 #### common\openecomp-common-configuration-management\openecomp-configuration-management-api\target
  32 #### common\openecomp-common-configuration-management\openecomp-configuration-management-cli\target
  33 #### common\openecomp-common-configuration-management\openecomp-configuration-management-core\target
  34
  35
  36
  37
  38
  39 # Accessing Common
  40
  41 ### Artifact Generator
  42
  43 #### api :
  44
  45  <dependency>
  46     <groupId>org.openecomp.sdc.common</groupId>
  47     <artifactId>openecomp-sdc-artifact-generator-api</artifactId>
  48     <version>?</version>
  49  </dependency>
  50
  51 #### core :
  52
  53  <dependency>
  54     <groupId>org.openecomp.sdc.common</groupId>
  55     <artifactId>openecomp-sdc-artifact-generator-core</artifactId>
  56     <version>?</version>
  57  </dependency>
  58
  59 ### Logging
  60
  61 #### api :
  62
  63  <dependency>
  64     <groupId>org.openecomp.sdc.common</groupId>
  65     <artifactId>openecomp-logging-api</artifactId>
  66     <version>?</version>
  67  </dependency>
  68
  69 #### core :
  70
  71  <dependency>
  72     <groupId>org.openecomp.sdc.common</groupId>
  73     <artifactId>openecomp-logging-core</artifactId>
  74     <version>?</version>
  75  </dependency>
  76
  77 ### Configuration Management
  78
  79 #### api :
  80
  81  <dependency>
  82     <groupId>org.openecomp.sdc.common</groupId>
  83     <artifactId>openecomp-configuration-management-api</artifactId>
  84     <version>?</version>
  85  </dependency>
  86
  87 #### cli :
  88
  89  <dependency>
  90      <groupId>org.openecomp.sdc.common</groupId>
  91      <artifactId>openecomp-configuration-management-cli</artifactId>
  92      <version>?</version>
  93   </dependency>
  94
  95 #### core :
  96
  97  <dependency>
  98     <groupId>org.openecomp.sdc.common</groupId>
  99     <artifactId>openecomp-configuration-management-core</artifactId>
 100     <version>?</version>
 101  </dependency>
 102
 103 ### NOTE : Artifact Generator generates artifacts using method 'generateArtifact' that takes the following arguments as input :
 104
 105 #### input(Specifies the list of input files as models)
 106 #### overridingConfiguration(Specifies the configuration data for invoking generators)
 107
 108 The output will be a list of artifacts that are generated by the generators as defined in the API signature.
 109
 110 # Logging
 111
 112 OpenECOMP Common supports EELF Logger, which is of the following types :
 113
 114 ### Error
 115 ### Debug
 116 ### Metrics
 117 ### Audit
 118