app-c/appc/README.md

   1 ## Introduction
   2 * Run 'mvn clean install' on this project in order to build and compile all artifacts contained in it.
   3 * The action above will produce a .zip file under the installer directory of each bundle, which can be installed during Docker Instantiation (Please see master README for more information on this).
   4
   5 ## Handling YANG Models
   6 * After running 'mvn clean install', this will generate some code from the yang models.
   7 * Modify the yang model file under the model project.
   8 * Follow the comments in the generated provider class to wire your new provider into the generated
   9 code.
  10 * Modify the generated provider model to respond to and handle the yang model. Depending on what
  11 you added to your model you may need to inherit additional interfaces or make other changes to
  12 the provider model.
  13
  14 ## Structure of a ODL Karaf Feature in APP-C
  15 * model
  16     - Provides the yang model for your application. This is your primary northbound interface.
  17 * provider
  18     - This is where the JAVA code is implemented. This part will define what the Karaf Feature will accomplish and how it will respond to a yang model.
  19 * features
  20     - Defines the contents of a Karaf Feature. If you add dependencies on third-party bundles, then you will need to
  21       modify the features.xml to list out the dependencies.
  22 * installer
  23     - Bundles all of the jars and third party dependencies (minus ODL dependencies) into a single
  24       .zip file with the necessary configuration files in order to install the Karaf Feature by means of calling the Karaf Client (which will ultimately run "feature:install <FEATURE_NAME>") in order to install the feature.
  25
  26