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      * @deprecated - No longer used or needed
  46      *
  47      * Suggested implementation until removed:
  48      * @code {
  49      * public Collection<ProviderFunctionality> getProviderFunctionality() {
  50      *  return Collections.emptySet();
  51      * }
  52      * }
  53      */
  54     @Deprecated
  55     public Collection<ProviderFunctionality> getProviderFunctionality();
  56
  57     /**
  58      * @deprecated - no longer used or needed
  59      */
  60     @Deprecated
  61     public interface ProviderFunctionality {
  62
  63     }
  64 }