aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/routerinterface/impl/RouterInterfaceManager.java
blob: 244a5c03a3cf0d44653b467a361a8bb1728cdc10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.vtnrsc.routerinterface.impl;

import static com.google.common.base.Preconditions.checkNotNull;
import static org.slf4j.LoggerFactory.getLogger;

import java.util.Collection;
import java.util.Collections;
import java.util.Set;

import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferenceCardinality;
import org.apache.felix.scr.annotations.Service;
import org.onlab.util.KryoNamespace;
import org.onosproject.core.ApplicationId;
import org.onosproject.core.CoreService;
import org.onosproject.store.serializers.KryoNamespaces;
import org.onosproject.store.service.EventuallyConsistentMap;
import org.onosproject.store.service.EventuallyConsistentMapEvent;
import org.onosproject.store.service.EventuallyConsistentMapListener;
import org.onosproject.store.service.StorageService;
import org.onosproject.store.service.WallClockTimestamp;
import org.onosproject.vtnrsc.RouterId;
import org.onosproject.vtnrsc.RouterInterface;
import org.onosproject.vtnrsc.SubnetId;
import org.onosproject.vtnrsc.TenantId;
import org.onosproject.vtnrsc.VirtualPortId;
import org.onosproject.vtnrsc.router.RouterService;
import org.onosproject.vtnrsc.routerinterface.RouterInterfaceEvent;
import org.onosproject.vtnrsc.routerinterface.RouterInterfaceListener;
import org.onosproject.vtnrsc.routerinterface.RouterInterfaceService;
import org.onosproject.vtnrsc.subnet.SubnetService;
import org.onosproject.vtnrsc.virtualport.VirtualPortService;
import org.slf4j.Logger;

import com.google.common.collect.Sets;

/**
 * Provides implementation of the Router interface service.
 */
@Component(immediate = true)
@Service
public class RouterInterfaceManager implements RouterInterfaceService {
    private static final String SUBNET_ID_NULL = "Subnet ID cannot be null";
    private static final String ROUTER_INTERFACE_NULL = "Router Interface cannot be null";
    private static final String ROUTER_INTERFACE = "vtn-router-interface-store";
    private static final String VTNRSC_APP = "org.onosproject.vtnrsc";
    private static final String LISTENER_NOT_NULL = "Listener cannot be null";
    private static final String EVENT_NOT_NULL = "event cannot be null";

    private final Logger log = getLogger(getClass());
    private final Set<RouterInterfaceListener> listeners = Sets
            .newCopyOnWriteArraySet();
    private EventuallyConsistentMapListener<SubnetId, RouterInterface> routerInterfaceListener =
            new InnerRouterInterfaceStoreListener();
    protected EventuallyConsistentMap<SubnetId, RouterInterface> routerInterfaceStore;
    protected ApplicationId appId;

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected StorageService storageService;

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected CoreService coreService;

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected VirtualPortService virtualPortService;

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected SubnetService subnetService;

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected RouterService routerService;

    @Activate
    public void activate() {
        appId = coreService.registerApplication(VTNRSC_APP);
        KryoNamespace.Builder serializer = KryoNamespace
                .newBuilder()
                .register(KryoNamespaces.API)
                .register(RouterId.class, TenantId.class, VirtualPortId.class,
                          RouterInterface.class, SubnetId.class);
        routerInterfaceStore = storageService
                .<SubnetId, RouterInterface>eventuallyConsistentMapBuilder()
                .withName(ROUTER_INTERFACE).withSerializer(serializer)
                .withTimestampProvider((k, v) -> new WallClockTimestamp())
                .build();
        routerInterfaceStore.addListener(routerInterfaceListener);
        log.info("Started");
    }

    @Deactivate
    public void deactivate() {
        routerInterfaceStore.removeListener(routerInterfaceListener);
        routerInterfaceStore.destroy();
        listeners.clear();
        log.info("Stopped");
    }

    @Override
    public boolean exists(SubnetId subnetId) {
        checkNotNull(subnetId, SUBNET_ID_NULL);
        return routerInterfaceStore.containsKey(subnetId);
    }

    @Override
    public Collection<RouterInterface> getRouterInterfaces() {
        return Collections
                .unmodifiableCollection(routerInterfaceStore.values());
    }

    @Override
    public RouterInterface getRouterInterface(SubnetId subnetId) {
        checkNotNull(subnetId, SUBNET_ID_NULL);
        return routerInterfaceStore.get(subnetId);
    }

    @Override
    public boolean addRouterInterface(RouterInterface routerInterface) {
        checkNotNull(routerInterface, ROUTER_INTERFACE_NULL);
        verifyRouterInterfaceData(routerInterface);
        routerInterfaceStore.put(routerInterface.subnetId(), routerInterface);
        if (!routerInterfaceStore.containsKey(routerInterface.subnetId())) {
            log.debug("The router interface is created failed whose identifier is {}",
                      routerInterface.subnetId().toString());
            return false;
        }
        return true;
    }

    @Override
    public boolean removeRouterInterface(RouterInterface routerInterface) {
        checkNotNull(routerInterface, ROUTER_INTERFACE_NULL);
        if (!routerInterfaceStore.containsKey(routerInterface.subnetId())) {
            log.debug("The router interface is not exist whose identifier is {}",
                      routerInterface.subnetId().toString());
            throw new IllegalArgumentException("subnet ID doesn't exist");
        }
        verifyRouterInterfaceData(routerInterface);
        routerInterfaceStore
                .remove(routerInterface.subnetId(), routerInterface);
        if (routerInterfaceStore.containsKey(routerInterface.subnetId())) {
            log.debug("The router interface deleted is failed whose identifier is {}",
                      routerInterface.subnetId().toString());
            return false;
        }
        return true;
    }

    @Override
    public void addListener(RouterInterfaceListener listener) {
        checkNotNull(listener, LISTENER_NOT_NULL);
        listeners.add(listener);
    }

    @Override
    public void removeListener(RouterInterfaceListener listener) {
        checkNotNull(listener, LISTENER_NOT_NULL);
        listeners.remove(listener);
    }

    /**
     * Verifies validity of Router interface data.
     *
     * @param routers router instance
     */
    private void verifyRouterInterfaceData(RouterInterface routerInterface) {
        checkNotNull(routerInterface, ROUTER_INTERFACE_NULL);
        if (!subnetService.exists(routerInterface.subnetId())) {
            log.debug("The subnet ID of interface is not exist whose identifier is {}",
                      routerInterface.subnetId().toString());
            throw new IllegalArgumentException(
                                               "subnet ID of interface doesn't exist");
        }
        if (!virtualPortService.exists(routerInterface.portId())) {
            log.debug("The port ID of interface is not exist whose identifier is {}",
                      routerInterface.portId().toString());
            throw new IllegalArgumentException(
                                               "port ID of interface doesn't exist");
        }
        if (!routerService.exists(routerInterface.routerId())) {
            log.debug("The router ID of interface is not exist whose identifier is {}",
                      routerInterface.routerId().toString());
            throw new IllegalArgumentException(
                                               "router ID of interface doesn't exist");
        }
    }

    private class InnerRouterInterfaceStoreListener
            implements
            EventuallyConsistentMapListener<SubnetId, RouterInterface> {

        @Override
        public void event(EventuallyConsistentMapEvent<SubnetId, RouterInterface> event) {
            checkNotNull(event, EVENT_NOT_NULL);
            RouterInterface routerInterface = event.value();
            if (EventuallyConsistentMapEvent.Type.PUT == event.type()) {
                notifyListeners(new RouterInterfaceEvent(
                                                         RouterInterfaceEvent.Type.ROUTER_INTERFACE_PUT,
                                                         routerInterface));
            }
            if (EventuallyConsistentMapEvent.Type.REMOVE == event.type()) {
                notifyListeners(new RouterInterfaceEvent(
                                                         RouterInterfaceEvent.Type.ROUTER_INTERFACE_DELETE,
                                                         routerInterface));
            }
        }
    }

    /**
     * Notifies specify event to all listeners.
     *
     * @param event Floating IP event
     */
    private void notifyListeners(RouterInterfaceEvent event) {
        checkNotNull(event, EVENT_NOT_NULL);
        listeners.forEach(listener -> listener.event(event));
    }
}