opendaylight/sal/yang-prototype/sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareService.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.sal.binding.api;\r
   9 \r
  10 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerSession;\r
  11 \r
  12 /**\r
  13  * \r
  14  * Session-specific instance of the broker functionality.\r
  15  * \r
  16  * <p>\r
  17  * BindingAwareService is marker interface for infrastructure services provided\r
  18  * by the SAL. These services are session-specific, each\r
  19  * {@link BindingAwareConsumer} and {@link BindingAwareProvider} usually has own\r
  20  * instance of the service with it's own context.\r
  21  * \r
  22  * <p>\r
  23  * The consumer's (or provider's) instance of specific service could be obtained\r
  24  * by invoking {@link ConsumerSession#getSALService(Class)} method on session\r
  25  * assigned to the consumer.\r
  26  * \r
  27  * <p>\r
  28  * {@link BindingAwareService} and {@link BindingAwareProvider} may seem\r
  29  * similar, but provider provides YANG model-based functionality and\r
  30  * {@link BindingAwareProvider} exposes the necessary supporting functionality\r
  31  * to implement specific functionality of YANG and to reuse it in the\r
  32  * development of {@link BindingAwareConsumer}s and {@link BindingAwareProvider}\r
  33  * s.\r
  34  * \r
  35 \r
  36  * \r
  37  */\r
  38 public interface BindingAwareService {\r
  39 \r
  40 }\r