opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.sal.binding.api;
   9
  10 import java.util.Collection;
  11
  12 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerContext;
  13 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  14 import org.opendaylight.yangtools.yang.binding.RpcService;
  15
  16 /**
  17  *
  18  * Defines the component of controller and supplies additional metadata. A
  19  * component of the controller or application supplies a concrete implementation
  20  * of this interface.
  21  *
  22  * <p>
  23  * A user-implemented component (application) which facilitates the SAL and SAL
  24  * services to access infrastructure services and to provide functionality to
  25  * {@link Consumer}s and other providers.
  26  *
  27  *
  28  */
  29 public interface BindingAwareProvider {
  30
  31     /**
  32      * Returns a set of provided implementations of YANG modules and their rpcs.
  33      *
  34      *
  35      * @return Set of provided implementation of YANG modules and their Rpcs
  36      */
  37     Collection<? extends RpcService> getImplementations();
  38
  39     /**
  40      * Gets a set of implementations of provider functionality to be registered
  41      * into system during the provider registration to the SAL.
  42      *
  43      * <p>
  44      * This method is invoked by {@link Broker#registerProvider(Provider)} to
  45      * learn the initial provided functionality
  46      *
  47      * @return Set of provider's functionality.
  48      */
  49     Collection<? extends ProviderFunctionality> getFunctionality();
  50
  51     /**
  52      * Functionality provided by the {@link BindingAwareProvider}
  53      *
  54      * <p>
  55      * Marker interface used to mark the interfaces describing specific
  56      * functionality which could be exposed by providers to other components.
  57      *
  58      *
  59      *
  60      */
  61     public interface ProviderFunctionality {
  62
  63     }
  64
  65     void onSessionInitiated(ProviderContext session);
  66
  67     void onSessionInitialized(ConsumerContext session);
  68
  69 }