yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.incubator.net.virtual.event; |
| 17 | |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 18 | import org.onlab.osgi.ServiceDirectory; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 19 | import org.onosproject.event.Event; |
| 20 | import org.onosproject.event.EventDeliveryService; |
| 21 | import org.onosproject.event.EventListener; |
Harold Huang | 4a65211 | 2017-03-29 00:06:27 +0800 | [diff] [blame] | 22 | import org.onosproject.event.ListenerRegistry; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 23 | import org.onosproject.event.ListenerService; |
| 24 | import org.onosproject.incubator.net.virtual.NetworkId; |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 25 | import org.onosproject.incubator.net.virtual.VirtualNetworkService; |
| 26 | import org.onosproject.incubator.net.virtual.VnetService; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 27 | |
| 28 | /** |
| 29 | * Basis for virtual event components which need to export listener mechanism. |
| 30 | */ |
| 31 | public abstract class AbstractVirtualListenerManager |
| 32 | <E extends Event, L extends EventListener<E>> |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame] | 33 | implements ListenerService<E, L>, VnetService { |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 34 | |
| 35 | protected final NetworkId networkId; |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 36 | protected final VirtualNetworkService manager; |
| 37 | protected final ServiceDirectory serviceDirectory; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 38 | |
| 39 | protected EventDeliveryService eventDispatcher; |
| 40 | |
Harold Huang | 4a65211 | 2017-03-29 00:06:27 +0800 | [diff] [blame] | 41 | private ListenerRegistry<E, L> listenerRegistry; |
| 42 | |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame] | 43 | private VirtualListenerRegistryManager listenerManager = |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 44 | VirtualListenerRegistryManager.getInstance(); |
| 45 | |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 46 | public AbstractVirtualListenerManager(VirtualNetworkService manager, |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame] | 47 | NetworkId networkId, |
| 48 | Class<? extends Event> eventClass) { |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 49 | this.manager = manager; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 50 | this.networkId = networkId; |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 51 | this.serviceDirectory = manager.getServiceDirectory(); |
| 52 | |
| 53 | //Set default event delivery service by default |
| 54 | this.eventDispatcher = serviceDirectory.get(EventDeliveryService.class); |
Harold Huang | 4a65211 | 2017-03-29 00:06:27 +0800 | [diff] [blame] | 55 | |
| 56 | //Initialize and reference to the listener registry |
| 57 | this.listenerRegistry = listenerManager.getRegistry(networkId, eventClass); |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 58 | } |
| 59 | |
| 60 | @Override |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame] | 61 | @SuppressWarnings("unchecked") |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 62 | public void addListener(L listener) { |
Harold Huang | 4a65211 | 2017-03-29 00:06:27 +0800 | [diff] [blame] | 63 | listenerRegistry.addListener(listener); |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 64 | } |
| 65 | |
| 66 | @Override |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame] | 67 | @SuppressWarnings("unchecked") |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 68 | public void removeListener(L listener) { |
Harold Huang | 4a65211 | 2017-03-29 00:06:27 +0800 | [diff] [blame] | 69 | listenerRegistry.removeListener(listener); |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Safely posts the specified event to the local event dispatcher. |
| 74 | * If there is no event dispatcher or if the event is null, this method |
| 75 | * is a noop. |
| 76 | * |
| 77 | * @param event event to be posted; may be null |
| 78 | */ |
| 79 | protected void post(E event) { |
| 80 | if (event != null && eventDispatcher != null) { |
| 81 | VirtualEvent<E> vEvent = |
| 82 | new VirtualEvent<E>(networkId, VirtualEvent.Type.POSTED, event); |
| 83 | eventDispatcher.post(vEvent); |
| 84 | } |
| 85 | } |
| 86 | |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 87 | @Override |
| 88 | public NetworkId networkId() { |
| 89 | return this.networkId; |
| 90 | } |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 91 | } |