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