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
9 package org.opendaylight.openflowplugin.api.openflow.md.core.session;
11 import com.google.common.util.concurrent.ListeningExecutorService;
12 import java.util.Collection;
13 import java.util.List;
15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
17 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
18 import org.opendaylight.openflowplugin.api.openflow.md.core.ConnectionConductor;
19 import org.opendaylight.openflowplugin.api.openflow.md.core.IMDMessageTranslator;
20 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
21 import org.opendaylight.openflowplugin.api.openflow.statistics.MessageSpy;
22 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
23 import org.opendaylight.openflowplugin.api.openflow.md.queue.PopListener;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
25 import org.opendaylight.yangtools.concepts.ListenerRegistration;
26 import org.opendaylight.yangtools.yang.binding.DataContainer;
27 import org.opendaylight.yangtools.yang.binding.DataObject;
32 public interface SessionManager extends AutoCloseable {
36 * @return corresponding conductor, holding {@link ConnectionAdapter} to
39 public SessionContext getSessionContext(SwitchSessionKeyOF sessionKey);
42 * disconnect all underlying {@link ConnectionAdapter}s and notify listeners
46 public void invalidateSessionContext(SwitchSessionKeyOF sessionKey);
49 * register session context
54 public void addSessionContext(SwitchSessionKeyOF sessionKey, SessionContext context);
55 public void setRole(SessionContext context);
58 * disconnect particular auxiliary {@link ConnectionAdapter}, identified by
59 * sessionKey and connectionCookie
62 * @param connectionCookie
64 public void invalidateAuxiliary(SwitchSessionKeyOF sessionKey,
65 SwitchConnectionDistinguisher connectionCookie);
68 * @param connectionConductor
70 public void invalidateOnDisconnect(ConnectionConductor connectionConductor);
73 * @param translatorMapping
75 public void setTranslatorMapping(Map<TranslatorKey, Collection<IMDMessageTranslator<OfHeader, List<DataObject>>>> translatorMapping);
78 * @return translator mapping
80 public Map<TranslatorKey, Collection<IMDMessageTranslator<OfHeader, List<DataObject>>>> getTranslatorMapping();
83 * @param notificationProviderService
85 public void setNotificationProviderService(NotificationProviderService notificationProviderService);
88 * @return notificationServiceProvider
90 public DataBroker getDataBroker();
95 public void setDataBroker(DataBroker dataBroker);
98 * @return notificationServiceProvider
100 public NotificationProviderService getNotificationProviderService();
104 * @return registration
106 public ListenerRegistration<SessionListener> registerSessionListener(SessionListener listener);
109 * @return popListener mapping, key=message type; value=collection of listeners
111 public Map<Class<? extends DataObject>, Collection<PopListener<DataObject>>> getPopListenerMapping();
114 * @param popListenerMapping the popListenerMapping to set
116 void setPopListenerMapping(Map<Class<? extends DataObject>, Collection<PopListener<DataObject>>> popListenerMapping);
119 * @param rpcPoolDelegator
121 void setRpcPool(ListeningExecutorService rpcPoolDelegator);
124 * @return the rpcPool instance
126 ListeningExecutorService getRpcPool();
131 void setMessageSpy(MessageSpy<DataContainer> messageSpy);
134 * @return the messageSpy
136 MessageSpy<DataContainer> getMessageSpy();
139 * @return collection of current sessions
141 Collection<SessionContext> getAllSessions();