binding/mdsal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.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 org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerContext;
  11
  12 /**
  13 *
  14 * A developer implemented component that gets registered with the Broker.
  15 *
  16 */
  17 public interface BindingAwareConsumer {
  18
  19     /**
  20      * Callback signaling initialization of the consumer session to the SAL.
  21      *
  22      * The consumer MUST use the session for all communication with SAL or
  23      * retrieving SAL infrastructure services.
  24      *
  25      * This method is invoked by
  26      * {@link BindingAwareBroker#registerConsumer(BindingAwareConsumer)}
  27      *
  28      * @param session
  29      *            Unique session between consumer and SAL.
  30      */
  31     void onSessionInitialized(ConsumerContext session);
  32
  33 }