README.md

   1 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.mdsal/mdsal-artifacts/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.mdsal/mdsal-artifacts)
   2 [![License](https://img.shields.io/badge/License-EPL%201.0-blue.svg)](https://opensource.org/licenses/EPL-1.0)
   3
   4 # MD-SAL
   5
   6 ## Overview
   7
   8 The Model-Driven Service Adaptation Layer (MD-SAL) is message-bus inspired
   9 extensible middleware component that provides messaging and data storage
  10 functionality based on data and interface models defined by application developers
  11 (i.e. user-defined models).
  12
  13 The MD-SAL:
  14
  15 * Defines a *common-layer, concepts, data model building blocks and messaging
  16    patterns* and provides infrastructure / framework for applications and
  17    inter-application communication.
  18
  19 // FIXME: Common integration point / reword this better
  20 * Provide common support for user-defined transport and payload formats, including
  21    payload serialization and adaptation (e.g. binary, XML or JSON).
  22
  23 The MD-SAL uses *YANG* as the modeling language for both interface and data
  24 definitions, and provides a messaging and data-centric runtime for such services
  25 based on YANG modeling.
  26
  27 The MD-SAL provides two different API types (flavours): +
  28
  29 Binding::
  30   MD-SAL APIs which extensively uses APIs and classes generated
  31   from YANG models, which provides compile-time safety and allows developers
  32   to use more natural way to work with data.
  33 DOM::
  34   (Document Object Model) APIs which uses DOM-like
  35   representation of data, which makes them more powerful, but provides less
  36   compile-time safety.
  37
  38 NOTE: Model-driven nature of the MD-SAL and *DOM*-based APIs allows for
  39 behind-the-scene API and payload type mediation and transformation
  40 to facilitate seamless communication between applications - this enables
  41 for other components and applications to provide connectors / expose different
  42 set of APIs and derive most of its functionality purely from models, which
  43 all existing code can benefit from without modification.
  44 For example *RESTCONF Connector* is an application built on top of MD-SAL
  45 and exposes YANG-modeled application APIs transparently via HTTP and adds support
  46 for XML and JSON payload type.
  47
  48 ## Contributing
  49
  50 MD-SAL is part of http://opendaylight.org[OpenDaylight Project], where we
  51 use http://git.opendaylight.org[Gerrit] for incoming patch reviews.