opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/BrokerService.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.core.api;
   9
  10 /**
  11  *
  12  * Session-specific instance of the broker functionality.
  13  *
  14  * <p>
  15  * BrokerService is marker interface for infrastructure services provided by the
  16  * SAL. These services are session-specific, each {@link Provider} and
  17  * {@link Consumer} usually has own instance of the service with it's own
  18  * context.
  19  *
  20  * <p>
  21  * The consumer's (or provider's) instance of specific service could be obtained
  22  * by invoking {@link org.opendaylight.controller.sal.core.api.Broker.ConsumerSession#getService(Class)} method on session
  23  * assigned to the consumer.
  24  *
  25  * <p>
  26  * {@link BrokerService} and {@link Provider} may seem similar, but provider
  27  * provides YANG model-based functionality and {@link BrokerService} exposes the
  28  * necessary supporting functionality to implement specific functionality of
  29  * YANG and to reuse it in the development of {@link Consumer}s and
  30  * {@link Provider}s.
  31  *
  32  *
  33  */
  34 public interface BrokerService {
  35
  36 }