README.md

   1 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.bgpcep/bgpcep-artifacts/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.bgpcep/bgpcep-artifacts)
   2 [![Javadocs](https://javadoc.io/badge2/org.opendaylight.bgpcep/bgpcep-karaf/javadoc.svg)](https://www.javadoc.io/doc/org.opendaylight.bgpcep)
   3 [![License](https://img.shields.io/badge/License-EPL%201.0-blue.svg)](https://opensource.org/licenses/EPL-1.0)
   4
   5 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
   6 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=alert_status)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
   7 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=sqale_index)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
   8 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=coverage)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
   9 [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=ncloc)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
  10 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=code_smells)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
  11 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
  12 [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=security_rating)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
  13 [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=vulnerabilities)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
  14 [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=opendaylight_bgpcep&metric=duplicated_lines_density)](https://sonarcloud.io/summary/overall?id=opendaylight_bgpcep)
  15
  16 # BGPCEP
  17
  18 BGPCEP project is an effort to bring two south-bound plugins into the controller:
  19 one for supporting BGP Linkstate Distribution as a source of L3 topology information,
  20 the other one to add support for Path Computation Element Protocol as a way to instantiate paths
  21 into the underlying network.
  22
  23 ## DIRECTORY ORGANIZATION
  24
  25 * concepts:
  26     * Common networking concepts, shared between the protocols
  27
  28 * util:
  29     * Common utility classes
  30
  31 * bgp:
  32     * BGP-related artifacts
  33
  34 * pcep:
  35     * PCEP-related artifacts
  36
  37 * rsvp:
  38     * RSVP modeling concepts (needed by pcep)
  39
  40 ## HOW TO BUILD
  41
  42 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
  43 a build going it's needed to:
  44
  45 1. Go in the root directory and run
  46    `mvn clean install`
  47
  48 2. After successful completion, look for org.opendaylight.bgpcep artifacts in your local maven repository.