opendaylight/sal/yang-prototype/sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.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 java.util.Collection;\r
  11 \r
  12 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerSession;\r
  13 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderSession;\r
  14 import org.opendaylight.controller.yang.binding.RpcService;\r
  15 \r
  16 \r
  17 /**\r
  18  * \r
  19  * Defines the component of controller and supplies additional metadata. A\r
  20  * component of the controller or application supplies a concrete implementation\r
  21  * of this interface.\r
  22  * \r
  23  * <p>\r
  24  * A user-implemented component (application) which facilitates the SAL and SAL\r
  25  * services to access infrastructure services and to provide functionality to\r
  26  * {@link Consumer}s and other providers.\r
  27  * \r
  28 \r
  29  * \r
  30  */\r
  31 public interface BindingAwareProvider {\r
  32 \r
  33     void onSessionInitialized(ConsumerSession session);\r
  34 \r
  35     /**\r
  36      * Returns a set of provided implementations of YANG modules and their rpcs.\r
  37      * \r
  38      * \r
  39      * @return Set of provided implementation of YANG modules and their Rpcs\r
  40      */\r
  41     Collection<? extends RpcService> getImplementations();\r
  42 \r
  43     /**\r
  44      * Gets a set of implementations of provider functionality to be registered\r
  45      * into system during the provider registration to the SAL.\r
  46      * \r
  47      * <p>\r
  48      * This method is invoked by {@link Broker#registerProvider(Provider)} to\r
  49      * learn the initial provided functionality\r
  50      * \r
  51      * @return Set of provider's functionality.\r
  52      */\r
  53     Collection<? extends ProviderFunctionality> getFunctionality();\r
  54 \r
  55     /**\r
  56      * Functionality provided by the {@link BindingAwareProvider}\r
  57      * \r
  58      * <p>\r
  59      * Marker interface used to mark the interfaces describing specific\r
  60      * functionality which could be exposed by providers to other components.\r
  61      * \r
  62 \r
  63      * \r
  64      */\r
  65     public interface ProviderFunctionality {\r
  66 \r
  67     }\r
  68 \r
  69     void onSessionInitiated(ProviderSession session);\r
  70 \r
  71 }\r
  72