opendaylight/sal/yang-prototype/sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.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  * Defines the component of controller and supplies additional metadata. A\r
  15  * component of the controller or application supplies a concrete implementation\r
  16  * of this interface.\r
  17  * \r
  18  * A user-implemented component (application) which faciliates the SAL and SAL\r
  19  * services to access infrastructure services or providers' functionality.\r
  20  * \r
  21 \r
  22  * \r
  23  */\r
  24 public interface BindingAwareConsumer {\r
  25 \r
  26     /**\r
  27      * Callback signaling initialization of the consumer session to the SAL.\r
  28      * \r
  29      * The consumer MUST use the session for all communication with SAL or\r
  30      * retrieving SAL infrastructure services.\r
  31      * \r
  32      * This method is invoked by\r
  33      * {@link BindingAwareBroker#registerConsumer(BindingAwareConsumer)}\r
  34      * \r
  35      * @param session\r
  36      *            Unique session between consumer and SAL.\r
  37      */\r
  38     void onSessionInitialized(ConsumerSession session);\r
  39 \r
  40 }\r