yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Laboratory |
| 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; |
| 22 | import org.onosproject.event.ListenerService; |
| 23 | import org.onosproject.incubator.net.virtual.NetworkId; |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 24 | import org.onosproject.incubator.net.virtual.VirtualNetworkService; |
| 25 | import org.onosproject.incubator.net.virtual.VnetService; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 26 | |
| 27 | /** |
| 28 | * Basis for virtual event components which need to export listener mechanism. |
| 29 | */ |
| 30 | public abstract class AbstractVirtualListenerManager |
| 31 | <E extends Event, L extends EventListener<E>> |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 32 | implements ListenerService<E, L>, VnetService { |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 33 | |
| 34 | protected final NetworkId networkId; |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 35 | protected final VirtualNetworkService manager; |
| 36 | protected final ServiceDirectory serviceDirectory; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 37 | |
| 38 | protected EventDeliveryService eventDispatcher; |
| 39 | |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 40 | private VirtualListenerRegistryManager listenerManager = |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 41 | VirtualListenerRegistryManager.getInstance(); |
| 42 | |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 43 | private Class<? extends Event> eventClass; |
| 44 | |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 45 | public AbstractVirtualListenerManager(VirtualNetworkService manager, |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 46 | NetworkId networkId, |
| 47 | Class<? extends Event> eventClass) { |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 48 | this.manager = manager; |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 49 | this.networkId = networkId; |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 50 | this.serviceDirectory = manager.getServiceDirectory(); |
| 51 | |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 52 | this.eventClass = eventClass; |
| 53 | |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 54 | //Set default event delivery service by default |
| 55 | this.eventDispatcher = serviceDirectory.get(EventDeliveryService.class); |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | @Override |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 59 | @SuppressWarnings("unchecked") |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 60 | public void addListener(L listener) { |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 61 | listenerManager.getRegistry(networkId, eventClass).addListener(listener); |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | @Override |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 65 | @SuppressWarnings("unchecked") |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 66 | public void removeListener(L listener) { |
Yoonseon Han | b14461b | 2017-03-07 14:08:01 +0900 | [diff] [blame^] | 67 | listenerManager.getRegistry(networkId, eventClass).removeListener(listener); |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Safely posts the specified event to the local event dispatcher. |
| 72 | * If there is no event dispatcher or if the event is null, this method |
| 73 | * is a noop. |
| 74 | * |
| 75 | * @param event event to be posted; may be null |
| 76 | */ |
| 77 | protected void post(E event) { |
| 78 | if (event != null && eventDispatcher != null) { |
| 79 | VirtualEvent<E> vEvent = |
| 80 | new VirtualEvent<E>(networkId, VirtualEvent.Type.POSTED, event); |
| 81 | eventDispatcher.post(vEvent); |
| 82 | } |
| 83 | } |
| 84 | |
yoonseon | c6a6927 | 2017-01-12 18:22:20 -0800 | [diff] [blame] | 85 | @Override |
| 86 | public NetworkId networkId() { |
| 87 | return this.networkId; |
| 88 | } |
yoonseon | fe72197 | 2017-01-10 17:18:49 -0800 | [diff] [blame] | 89 | } |