opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.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 java.util.Collection;
  11
  12 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
  13
  14 /**
  15  *
  16  * Defines the component of controller and supplies additional metadata. A
  17  * component of the controller or application supplies a concrete implementation
  18  * of this interface.
  19  *
  20  * <p>
  21  * A user-implemented component (application) which facilitates the SAL and SAL
  22  * services to access infrastructure services and to provide functionality to
  23  * {@link Consumer}s and other providers.
  24  *
  25  *
  26  */
  27 public interface Provider {
  28
  29     /**
  30      * Callback signaling initialization of the provider session to the SAL.
  31      *
  32      * <p>
  33      * The provider <b>MUST use the session</b> for all communication with SAL
  34      * or retrieving SAL infrastructure services.
  35      *
  36      * <p>
  37      * This method is invoked by {@link Broker#registerConsumer(Consumer)}
  38      *
  39      * @param session
  40      *            Unique session between provider and SAL.
  41      */
  42     public void onSessionInitiated(ProviderSession session);
  43
  44     /**
  45      * Gets a set of implementations of provider functionality to be registered
  46      * into system during the provider registration to the SAL.
  47      *
  48      * <p>
  49      * This method is invoked by {@link Broker#registerProvider(Provider)} to
  50      * learn the initial provided functionality
  51      *
  52      * @return Set of provider's functionality.
  53      */
  54     public Collection<ProviderFunctionality> getProviderFunctionality();
  55
  56     /**
  57      * Functionality provided by the {@link Provider}
  58      *
  59      * <p>
  60      * Marker interface used to mark the interfaces describing specific
  61      * functionality which could be exposed by providers to other components.
  62      *
  63
  64      *
  65      */
  66     public interface ProviderFunctionality {
  67
  68     }
  69 }