2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.core.api;
10 import java.util.Collection;
11 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
14 * Defines the component of controller and supplies additional metadata. A
15 * component of the controller or application supplies a concrete implementation
19 * A user-implemented component (application) which facilitates the SAL and SAL
20 * services to access infrastructure services or providers' functionality.
22 * @deprecated Use blueprint instead for code wiring.
25 public interface Consumer {
28 * Callback signaling initialization of the consumer session to the SAL.
31 * The consumer MUST use the session for all communication with SAL or
32 * retrieving SAL infrastructure services.
35 * This method is invoked by {@link Broker#registerConsumer(Consumer)}
38 * Unique session between consumer and SAL.
40 void onSessionInitiated(ConsumerSession session);
45 * @deprecated - no longer used or needed. Suggested implementation until removed:
47 * public Collection<ConsumerFunctionality> getConsumerFunctionality() {
48 * return Collections.emptySet();
53 Collection<ConsumerFunctionality> getConsumerFunctionality();
58 * @deprecated - no longer used or needed
61 interface ConsumerFunctionality {