2a54c7d855761274f7e11136f000c03212f513a3
[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / sal / binding / api / BindingAwareService.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.md.sal.binding.api.BindingService;
11
12 /**
13  * Session-specific instance of the broker functionality.
14  *
15  * <p>
16  * BindingAwareService is marker interface for infrastructure services provided
17  * by the SAL. These services are session-specific, each
18  * {@link BindingAwareConsumer} and {@link BindingAwareProvider} usually has own
19  * instance of the service with it's own context.
20  *
21  * <p>
22  * The consumer's (or provider's) instance of specific service could be obtained by invoking
23  * {@link org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerContext#getSALService(Class)}
24  * method on session assigned to the consumer.
25  *
26  * <p>
27  * {@link org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerContext}
28  * and {@link BindingAwareProvider} may seem similar, but provider provides YANG model-based functionality and
29  * {@link BindingAwareProvider} exposes the necessary supporting functionality
30  * to implement specific functionality of YANG and to reuse it in the
31  * development of {@link BindingAwareConsumer}s and {@link BindingAwareProvider}s.
32  *
33  * @deprecated Use {@link BindingService} instead.
34  */
35 @Deprecated
36 public interface BindingAwareService {
37
38 }

©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.