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

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.