2 * Copyright © 2017 Orange, 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.transportpce.servicehandler.listeners;
10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
11 import java.util.ArrayList;
12 import java.util.List;
14 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
15 import org.opendaylight.transportpce.common.OperationResult;
16 import org.opendaylight.transportpce.common.StringConstants;
17 import org.opendaylight.transportpce.networkmodel.service.NetworkModelService;
18 import org.opendaylight.transportpce.pce.service.PathComputationService;
19 import org.opendaylight.transportpce.servicehandler.ServiceInput;
20 import org.opendaylight.transportpce.servicehandler.service.PCEServiceWrapper;
21 import org.opendaylight.transportpce.servicehandler.service.ServiceDataStoreOperations;
22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210915.RendererRpcResultSp;
23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210915.TransportpceRendererListener;
24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210915.renderer.rpc.result.sp.Link;
25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.servicehandler.rev201125.ServiceRpcResultSh;
26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.servicehandler.rev201125.ServiceRpcResultShBuilder;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.service.types.rev211210.ServiceNotificationTypes;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.service.list.Services;
31 import org.opendaylight.yang.gen.v1.http.transportpce.topology.rev220123.OtnLinkType;
32 import org.opendaylight.yang.gen.v1.nbi.notifications.rev210813.PublishNotificationProcessService;
33 import org.opendaylight.yang.gen.v1.nbi.notifications.rev210813.PublishNotificationProcessServiceBuilder;
34 import org.opendaylight.yang.gen.v1.nbi.notifications.rev210813.notification.process.service.ServiceAEndBuilder;
35 import org.opendaylight.yang.gen.v1.nbi.notifications.rev210813.notification.process.service.ServiceZEndBuilder;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 * Calls to listen to Renderer notifications.
42 * @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
45 public class RendererListenerImpl implements TransportpceRendererListener {
47 private static final String PUBLISHER = "RendererListener";
48 private static final Logger LOG = LoggerFactory.getLogger(RendererListenerImpl.class);
49 private RendererRpcResultSp serviceRpcResultSp;
50 private ServiceDataStoreOperations serviceDataStoreOperations;
51 private ServiceInput input;
52 private PCEServiceWrapper pceServiceWrapper;
53 private Boolean tempService;
54 private NotificationPublishService notificationPublishService;
55 private final NetworkModelService networkModelService;
58 public RendererListenerImpl(PathComputationService pathComputationService,
59 NotificationPublishService notificationPublishService, NetworkModelService networkModelService) {
60 this.pceServiceWrapper = new PCEServiceWrapper(pathComputationService, notificationPublishService);
61 setServiceInput(null);
62 setTempService(false);
63 this.notificationPublishService = notificationPublishService;
64 this.networkModelService = networkModelService;
68 public void onRendererRpcResultSp(RendererRpcResultSp notification) {
69 if (compareServiceRpcResultSp(notification)) {
70 LOG.warn("ServiceRpcResultSp already wired !");
73 serviceRpcResultSp = notification;
74 int notifType = serviceRpcResultSp.getNotificationType().getIntValue();
75 LOG.info("Renderer '{}' Notification received : {}", serviceRpcResultSp.getNotificationType().getName(),
78 /* service-implementation-request. */
80 onServiceImplementationResult(notification);
84 onServiceDeleteResult(notification);
92 * Process service delete result for serviceName.
93 * @param notification RendererRpcResultSp
95 private void onServiceDeleteResult(RendererRpcResultSp notification) {
96 switch (serviceRpcResultSp.getStatus()) {
98 updateOtnTopology(notification, true);
101 LOG.error("Renderer service delete failed !");
102 Services service = serviceDataStoreOperations.getService(input.getServiceName()).get();
103 sendNbiNotification(new PublishNotificationProcessServiceBuilder()
104 .setServiceName(service.getServiceName())
105 .setServiceAEnd(new ServiceAEndBuilder(service.getServiceAEnd()).build())
106 .setServiceZEnd(new ServiceZEndBuilder(service.getServiceZEnd()).build())
107 .setCommonId(service.getCommonId())
108 .setConnectionType(service.getConnectionType())
109 .setResponseFailed("Renderer service delete failed !")
110 .setMessage("ServiceDelete request failed ...")
111 .setOperationalState(service.getOperationalState())
112 .setPublisherName(PUBLISHER)
116 LOG.warn("Renderer service delete returned a Pending RpcStatusEx code!");
119 LOG.error("Renderer service delete returned an unknown RpcStatusEx code!");
122 LOG.info("Service '{}' deleted !", notification.getServiceName());
123 if (this.input == null) {
124 LOG.error("ServiceInput parameter is null !");
127 LOG.info("sending PCE cancel resource reserve for '{}'", this.input.getServiceName());
128 this.pceServiceWrapper.cancelPCEResource(this.input.getServiceName(),
129 ServiceNotificationTypes.ServiceDeleteResult);
130 sendServiceHandlerNotification(notification, ServiceNotificationTypes.ServiceDeleteResult);
134 * Process service implementation result for serviceName.
135 * @param notification RendererRpcResultSp
137 private void onServiceImplementationResult(RendererRpcResultSp notification) {
138 switch (serviceRpcResultSp.getStatus()) {
140 onSuccededServiceImplementation(notification);
143 onFailedServiceImplementation(notification.getServiceName());
146 LOG.warn("Service Implementation still pending according to RpcStatusEx");
149 LOG.warn("Service Implementation has an unknown RpcStatusEx code");
155 * Process succeeded service implementation for service.
156 * @param notification RendererRpcResultSp
158 private void onSuccededServiceImplementation(RendererRpcResultSp notification) {
159 LOG.info("Service implemented !");
160 if (serviceDataStoreOperations == null) {
161 LOG.debug("serviceDataStoreOperations is null");
165 updateOtnTopology(notification, false);
167 PublishNotificationProcessServiceBuilder nbiNotificationBuilder = new PublishNotificationProcessServiceBuilder()
168 .setServiceName(input.getServiceName())
169 .setServiceAEnd(new ServiceAEndBuilder(input.getServiceAEnd()).build())
170 .setServiceZEnd(new ServiceZEndBuilder(input.getServiceZEnd()).build())
171 .setCommonId(input.getCommonId()).setConnectionType(input.getConnectionType())
172 .setPublisherName(PUBLISHER);
173 OperationResult operationResult;
174 String serviceTemp = "";
176 operationResult = this.serviceDataStoreOperations.modifyTempService(
177 serviceRpcResultSp.getServiceName(), State.InService, AdminStates.InService);
178 serviceTemp = "Temp ";
180 operationResult = this.serviceDataStoreOperations.modifyService(
181 serviceRpcResultSp.getServiceName(), State.InService, AdminStates.InService);
183 if (operationResult.isSuccess()) {
184 sendNbiNotification(nbiNotificationBuilder
185 .setResponseFailed("")
186 .setMessage("Service implemented !")
187 .setOperationalState(State.InService)
190 sendServiceHandlerNotification(notification, ServiceNotificationTypes.ServiceCreateResult);
193 LOG.warn("{}Service status not updated in datastore !", serviceTemp);
194 sendNbiNotification(nbiNotificationBuilder
195 .setResponseFailed(serviceTemp + "Service status not updated in datastore !")
196 .setMessage("ServiceCreate request failed ...")
197 .setOperationalState(State.OutOfService)
203 * Create and send service handler notification.
204 * @param notification RendererRpcResultSp
205 * @param type ServiceNotificationTypes
207 private void sendServiceHandlerNotification(RendererRpcResultSp notification, ServiceNotificationTypes type) {
209 ServiceRpcResultSh serviceHandlerNotification = new ServiceRpcResultShBuilder()
210 .setAToZDirection(notification.getAToZDirection())
211 .setZToADirection(notification.getZToADirection())
212 .setServiceName(notification.getServiceName())
213 .setStatus(notification.getStatus())
214 .setStatusMessage(notification.getStatusMessage())
215 .setNotificationType(type)
217 LOG.debug("Service update in datastore OK, sending notification {}", serviceHandlerNotification);
218 notificationPublishService.putNotification(
219 serviceHandlerNotification);
220 } catch (InterruptedException e) {
221 LOG.warn("Something went wrong while sending notification for service {}",
222 serviceRpcResultSp.getServiceName(), e);
223 Thread.currentThread().interrupt();
228 * Process failed service implementation for serviceName.
229 * @param serviceName String
231 private void onFailedServiceImplementation(String serviceName) {
232 LOG.error("Renderer implementation failed !");
233 Services service = serviceDataStoreOperations.getService(input.getServiceName()).get();
234 sendNbiNotification(new PublishNotificationProcessServiceBuilder()
235 .setServiceName(service.getServiceName())
236 .setServiceAEnd(new ServiceAEndBuilder(service.getServiceAEnd()).build())
237 .setServiceZEnd(new ServiceZEndBuilder(service.getServiceZEnd()).build())
238 .setCommonId(service.getCommonId())
239 .setConnectionType(service.getConnectionType())
240 .setResponseFailed("Renderer implementation failed !")
241 .setMessage("ServiceCreate request failed ...")
242 .setOperationalState(service.getOperationalState())
243 .setPublisherName(PUBLISHER)
245 OperationResult deleteServicePathOperationResult =
246 this.serviceDataStoreOperations.deleteServicePath(serviceName);
247 if (!deleteServicePathOperationResult.isSuccess()) {
248 LOG.warn("Service path was not removed from datastore!");
250 OperationResult deleteServiceOperationResult;
251 String serviceType = "";
253 deleteServiceOperationResult = this.serviceDataStoreOperations.deleteTempService(serviceName);
254 serviceType = "Temp ";
256 deleteServiceOperationResult = this.serviceDataStoreOperations.deleteService(serviceName);
258 if (deleteServiceOperationResult.isSuccess()) {
259 LOG.warn("{}Service was not removed from datastore!", serviceType);
264 value = "ES_COMPARING_STRINGS_WITH_EQ",
265 justification = "false positives, not strings but real object references comparisons")
266 private Boolean compareServiceRpcResultSp(RendererRpcResultSp notification) {
267 if (serviceRpcResultSp == null
268 || serviceRpcResultSp.getNotificationType() != notification.getNotificationType()
269 || serviceRpcResultSp.getServiceName() != notification.getServiceName()
270 || serviceRpcResultSp.getStatus() != notification.getStatus()
271 || serviceRpcResultSp.getStatusMessage() != notification.getStatusMessage()) {
277 public void setServiceInput(ServiceInput serviceInput) {
278 this.input = serviceInput;
281 public void setserviceDataStoreOperations(ServiceDataStoreOperations serviceData) {
282 this.serviceDataStoreOperations = serviceData;
285 public void setTempService(Boolean tempService) {
286 this.tempService = tempService;
290 * Send notification to NBI notification in order to publish message.
291 * @param service PublishNotificationService
293 private void sendNbiNotification(PublishNotificationProcessService service) {
295 notificationPublishService.putNotification(service);
296 } catch (InterruptedException e) {
297 LOG.warn("Cannot send notification to nbi", e);
298 Thread.currentThread().interrupt();
303 private void updateOtnTopology(RendererRpcResultSp notification, boolean isDeletion) {
304 Link link = notification.getLink();
305 if (link == null && notification.getLinkId() == null) {
308 List<String> supportedLinkIds = null;
309 if (notification.getLinkId() != null) {
310 supportedLinkIds = new ArrayList<>(notification.getLinkId());
312 String serviceType = notification.getServiceType();
313 switch (serviceType) {
314 case StringConstants.SERVICE_TYPE_OTU4:
315 case StringConstants.SERVICE_TYPE_OTUC2:
316 case StringConstants.SERVICE_TYPE_OTUC3:
317 case StringConstants.SERVICE_TYPE_OTUC4:
318 case StringConstants.SERVICE_TYPE_ODU4:
319 case StringConstants.SERVICE_TYPE_ODUC2:
320 case StringConstants.SERVICE_TYPE_ODUC3:
321 case StringConstants.SERVICE_TYPE_ODUC4:
322 Map<String, OtnLinkType> otnLinkTypeMap = Map.of(
323 StringConstants.SERVICE_TYPE_OTU4, OtnLinkType.OTU4,
324 // TODO: need to change it when OtnLinkType is updated with enum
325 StringConstants.SERVICE_TYPE_OTUC2, OtnLinkType.OTUC4,
326 StringConstants.SERVICE_TYPE_OTUC3, OtnLinkType.OTUC4,
327 StringConstants.SERVICE_TYPE_OTUC4, OtnLinkType.OTUC4,
328 StringConstants.SERVICE_TYPE_ODU4, OtnLinkType.ODTU4,
329 // TODO: need to change it when OtnLinkType is updated with enum
330 StringConstants.SERVICE_TYPE_ODUC2, OtnLinkType.ODUC4,
331 StringConstants.SERVICE_TYPE_ODUC3, OtnLinkType.ODUC4,
332 StringConstants.SERVICE_TYPE_ODUC4, OtnLinkType.ODUC4);
334 LOG.info("updating otn-topology removing links");
335 this.networkModelService.deleteOtnLinks(link, supportedLinkIds, otnLinkTypeMap.get(serviceType));
337 LOG.info("updating otn-topology adding links");
338 this.networkModelService.createOtnLinks(link, supportedLinkIds, otnLinkTypeMap.get(serviceType));
341 case StringConstants.SERVICE_TYPE_1GE:
342 case StringConstants.SERVICE_TYPE_10GE:
343 case StringConstants.SERVICE_TYPE_100GE_M:
344 Short tribPort = Short.valueOf(notification.getAToZDirection().getMinTribSlot().getValue()
346 Short minTribSlot = Short.valueOf(notification.getAToZDirection().getMinTribSlot().getValue()
348 Short maxTribSlot = Short.valueOf(notification.getAToZDirection().getMaxTribSlot().getValue()
350 LOG.info("updating otn-topology node tps -tps and tpn pools");
351 this.networkModelService.updateOtnLinks(link, supportedLinkIds,
352 notification.getAToZDirection().getRate(), tribPort, minTribSlot, maxTribSlot, isDeletion);
354 case StringConstants.SERVICE_TYPE_100GE_S:
355 this.networkModelService.updateOtnLinks(supportedLinkIds, isDeletion);
358 LOG.warn("service-type {} not managed yet", serviceType);