servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/listeners/RendererListenerImpl.java

   1 /*
   2  * Copyright © 2017 Orange, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.transportpce.servicehandler.listeners;
   9
  10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Map;
  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.networkutils.rev220630.OtnLinkType;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210915.RendererRpcResultSp;
  24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210915.TransportpceRendererListener;
  25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.renderer.rev210915.renderer.rpc.result.sp.Link;
  26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.servicehandler.rev201125.ServiceRpcResultSh;
  27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.servicehandler.rev201125.ServiceRpcResultShBuilder;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.service.types.rev211210.ServiceNotificationTypes;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.ServiceRpcResult;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.ServiceRpcResultBuilder;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.service.list.Services;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.service.rpc.result.PathComputationResultBuilder;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.service.rpc.result.path.computation.result.AToZBuilder;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev211210.service.rpc.result.path.computation.result.ZToABuilder;
  37 import org.opendaylight.yang.gen.v1.nbi.notifications.rev211013.PublishNotificationProcessService;
  38 import org.opendaylight.yang.gen.v1.nbi.notifications.rev211013.PublishNotificationProcessServiceBuilder;
  39 import org.opendaylight.yang.gen.v1.nbi.notifications.rev211013.notification.process.service.ServiceAEndBuilder;
  40 import org.opendaylight.yang.gen.v1.nbi.notifications.rev211013.notification.process.service.ServiceZEndBuilder;
  41 import org.osgi.service.component.annotations.Activate;
  42 import org.osgi.service.component.annotations.Component;
  43 import org.osgi.service.component.annotations.Reference;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Calls to listen to Renderer notifications.
  49  *
  50  * @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
  51  *
  52  */
  53 @Component
  54 public class RendererListenerImpl implements TransportpceRendererListener, RendererListener {
  55
  56     private static final String PUBLISHER = "RendererListener";
  57     private static final Logger LOG = LoggerFactory.getLogger(RendererListenerImpl.class);
  58     private RendererRpcResultSp serviceRpcResultSp;
  59     private ServiceDataStoreOperations serviceDataStoreOperations;
  60     private ServiceInput input;
  61     private PCEServiceWrapper pceServiceWrapper;
  62     private Boolean tempService;
  63     private NotificationPublishService notificationPublishService;
  64     private final NetworkModelService networkModelService;
  65
  66
  67     @Activate
  68     public RendererListenerImpl(@Reference PathComputationService pathComputationService,
  69             @Reference NotificationPublishService notificationPublishService,
  70             @Reference NetworkModelService networkModelService) {
  71         this.pceServiceWrapper = new PCEServiceWrapper(pathComputationService, notificationPublishService);
  72         setServiceInput(null);
  73         setTempService(false);
  74         this.notificationPublishService = notificationPublishService;
  75         this.networkModelService = networkModelService;
  76     }
  77
  78     @Override
  79     public void onRendererRpcResultSp(RendererRpcResultSp notification) {
  80         if (compareServiceRpcResultSp(notification)) {
  81             LOG.warn("ServiceRpcResultSp already wired !");
  82             return;
  83         }
  84         serviceRpcResultSp = notification;
  85         int notifType = serviceRpcResultSp.getNotificationType().getIntValue();
  86         LOG.info("Renderer '{}' Notification received : {}", serviceRpcResultSp.getNotificationType().getName(),
  87                 notification);
  88         switch (notifType) {
  89             /* service-implementation-request. */
  90             case 3:
  91                 onServiceImplementationResult(notification);
  92                 break;
  93             /* service-delete. */
  94             case 4:
  95                 onServiceDeleteResult(notification);
  96                 break;
  97             default:
  98                 break;
  99         }
 100     }
 101
 102     /**
 103      * Process service delete result for serviceName.
 104      * @param notification RendererRpcResultSp
 105      */
 106     private void onServiceDeleteResult(RendererRpcResultSp notification) {
 107         switch (serviceRpcResultSp.getStatus()) {
 108             case Successful:
 109                 updateOtnTopology(notification, true);
 110                 break;
 111             case Failed:
 112                 LOG.error("Renderer service delete failed !");
 113                 Services service = serviceDataStoreOperations.getService(input.getServiceName()).orElseThrow();
 114                 sendNbiNotification(new PublishNotificationProcessServiceBuilder()
 115                         .setServiceName(service.getServiceName())
 116                         .setServiceAEnd(new ServiceAEndBuilder(service.getServiceAEnd()).build())
 117                         .setServiceZEnd(new ServiceZEndBuilder(service.getServiceZEnd()).build())
 118                         .setCommonId(service.getCommonId())
 119                         .setConnectionType(service.getConnectionType())
 120                         .setResponseFailed("Renderer service delete failed !")
 121                         .setMessage("ServiceDelete request failed ...")
 122                         .setOperationalState(service.getOperationalState())
 123                         .setPublisherName(PUBLISHER)
 124                         .build());
 125                 return;
 126             case Pending:
 127                 LOG.warn("Renderer service delete returned a Pending RpcStatusEx code!");
 128                 return;
 129             default:
 130                 LOG.error("Renderer service delete returned an unknown RpcStatusEx code!");
 131                 return;
 132         }
 133         LOG.info("Service '{}' deleted !", notification.getServiceName());
 134         if (this.input == null) {
 135             LOG.error("ServiceInput parameter is null !");
 136             return;
 137         }
 138         LOG.info("sending PCE cancel resource reserve for '{}'", this.input.getServiceName());
 139         this.pceServiceWrapper.cancelPCEResource(this.input.getServiceName(),
 140                 ServiceNotificationTypes.ServiceDeleteResult);
 141         sendServiceHandlerNotification(notification, ServiceNotificationTypes.ServiceDeleteResult);
 142     }
 143
 144     /**
 145      * Process service implementation result for serviceName.
 146      * @param notification RendererRpcResultSp
 147      */
 148     private void onServiceImplementationResult(RendererRpcResultSp notification) {
 149         switch (serviceRpcResultSp.getStatus()) {
 150             case Successful:
 151                 onSuccededServiceImplementation(notification);
 152                 break;
 153             case Failed:
 154                 onFailedServiceImplementation(notification.getServiceName());
 155                 break;
 156             case Pending:
 157                 LOG.warn("Service Implementation still pending according to RpcStatusEx");
 158                 break;
 159             default:
 160                 LOG.warn("Service Implementation has an unknown RpcStatusEx code");
 161                 break;
 162         }
 163     }
 164
 165     /**
 166      * Process succeeded service implementation for service.
 167      * @param notification RendererRpcResultSp
 168      */
 169     private void onSuccededServiceImplementation(RendererRpcResultSp notification) {
 170         LOG.info("Service implemented !");
 171         if (serviceDataStoreOperations == null) {
 172             LOG.debug("serviceDataStoreOperations is null");
 173             return;
 174         }
 175
 176         updateOtnTopology(notification, false);
 177         PublishNotificationProcessServiceBuilder nbiNotificationBuilder = new PublishNotificationProcessServiceBuilder()
 178                 .setServiceName(input.getServiceName())
 179                 .setServiceAEnd(new ServiceAEndBuilder(input.getServiceAEnd()).build())
 180                 .setServiceZEnd(new ServiceZEndBuilder(input.getServiceZEnd()).build())
 181                 .setCommonId(input.getCommonId()).setConnectionType(input.getConnectionType())
 182                 .setPublisherName(PUBLISHER);
 183         OperationResult operationResult;
 184         String serviceTemp = "";
 185         if (tempService) {
 186             operationResult = this.serviceDataStoreOperations.modifyTempService(
 187                     serviceRpcResultSp.getServiceName(), State.InService, AdminStates.InService);
 188             serviceTemp = "Temp ";
 189             LOG.info("Sending notification to the service-RPC-result");
 190         } else {
 191             operationResult = this.serviceDataStoreOperations.modifyService(
 192                     serviceRpcResultSp.getServiceName(), State.InService, AdminStates.InService);
 193         }
 194         if (operationResult.isSuccess()) {
 195             sendNbiNotification(nbiNotificationBuilder
 196                     .setResponseFailed("")
 197                     .setMessage("Service implemented !")
 198                     .setOperationalState(State.InService)
 199                     .build());
 200             if (!tempService) {
 201                 sendServiceHandlerNotification(notification, ServiceNotificationTypes.ServiceCreateResult);
 202             } else {
 203                 LOG.info("For the Temp service, sending notification on service-result-rpc");
 204                 sendServiceRpcResultNotification(notification, ServiceNotificationTypes.ServiceCreateResult);
 205             }
 206         } else {
 207             LOG.warn("{}Service status not updated in datastore !", serviceTemp);
 208             sendNbiNotification(nbiNotificationBuilder
 209                     .setResponseFailed(serviceTemp + "Service status not updated in datastore !")
 210                     .setMessage("ServiceCreate request failed ...")
 211                     .setOperationalState(State.OutOfService)
 212                     .build());
 213         }
 214     }
 215
 216     /**
 217      * Create and send service handler notification.
 218      * @param notification RendererRpcResultSp
 219      * @param type ServiceNotificationTypes
 220      */
 221     private void sendServiceHandlerNotification(RendererRpcResultSp notification, ServiceNotificationTypes type) {
 222         try {
 223             ServiceRpcResultSh serviceHandlerNotification = new ServiceRpcResultShBuilder()
 224                     .setAToZDirection(notification.getAToZDirection())
 225                     .setZToADirection(notification.getZToADirection())
 226                     .setServiceName(notification.getServiceName())
 227                     .setStatus(notification.getStatus())
 228                     .setStatusMessage(notification.getStatusMessage())
 229                     .setNotificationType(type)
 230                     .build();
 231             LOG.debug("Service update in datastore OK, sending notification {}", serviceHandlerNotification);
 232             notificationPublishService.putNotification(
 233                     serviceHandlerNotification);
 234         } catch (InterruptedException e) {
 235             LOG.warn("Something went wrong while sending notification for service {}",
 236                     serviceRpcResultSp.getServiceName(), e);
 237             Thread.currentThread().interrupt();
 238         }
 239     }
 240
 241     private void sendServiceRpcResultNotification(RendererRpcResultSp notification, ServiceNotificationTypes type) {
 242         try {
 243             ServiceRpcResult serviceRpcResult = new ServiceRpcResultBuilder()
 244                     .setServiceName(notification.getServiceName())
 245                     .setNotificationType(type)
 246                     .setStatusMessage(notification.getStatusMessage())
 247                     .setCommonId(notification.getCommonId())
 248                     .setPathComputationResult(new PathComputationResultBuilder()
 249                             .setAToZ(new AToZBuilder()
 250                                             .setFrequency(notification
 251                                                             .getAToZDirection()
 252                                                             .getCentralFrequency())
 253                                             .setWidth(notification
 254                                                             .getAToZDirection()
 255                                                             .getWidth())
 256                                             // TODO: here the optical operational mode should be set
 257                                             // TODO: also set the GNSR, OSNR, power values
 258                                             .setOpticalOperationalMode("test")
 259                                             .build())
 260                             .setZToA(new ZToABuilder()
 261                                             .setFrequency(notification
 262                                                             .getZToADirection()
 263                                                             .getCentralFrequency())
 264                                             .setWidth(notification
 265                                                             .getZToADirection()
 266                                                             .getWidth())
 267                                             // TODO: here the optical operational mode should be set
 268                                             // TODO: also set the GNSR, OSNR, power values
 269                                             .setOpticalOperationalMode("test")
 270                                             .build())
 271                             .build())
 272                     .build();
 273             LOG.info("Sending the notification for service-rpc-result {}", serviceRpcResult);
 274             notificationPublishService.putNotification(
 275                     serviceRpcResult);
 276         } catch (InterruptedException e) {
 277             LOG.warn("Something went wrong while sending notification for service {}",
 278                     serviceRpcResultSp.getServiceName(), e);
 279             Thread.currentThread().interrupt();
 280         }
 281     }
 282
 283
 284
 285     /**
 286      * Process failed service implementation for serviceName.
 287      * @param serviceName String
 288      */
 289     private void onFailedServiceImplementation(String serviceName) {
 290         LOG.error("Renderer implementation failed !");
 291         Services service = serviceDataStoreOperations.getService(input.getServiceName()).orElseThrow();
 292         sendNbiNotification(new PublishNotificationProcessServiceBuilder()
 293                 .setServiceName(service.getServiceName())
 294                 .setServiceAEnd(new ServiceAEndBuilder(service.getServiceAEnd()).build())
 295                 .setServiceZEnd(new ServiceZEndBuilder(service.getServiceZEnd()).build())
 296                 .setCommonId(service.getCommonId())
 297                 .setConnectionType(service.getConnectionType())
 298                 .setResponseFailed("Renderer implementation failed !")
 299                 .setMessage("ServiceCreate request failed ...")
 300                 .setOperationalState(service.getOperationalState())
 301                 .setPublisherName(PUBLISHER)
 302                 .build());
 303         OperationResult deleteServicePathOperationResult =
 304                 this.serviceDataStoreOperations.deleteServicePath(serviceName);
 305         if (!deleteServicePathOperationResult.isSuccess()) {
 306             LOG.warn("Service path was not removed from datastore!");
 307         }
 308         OperationResult deleteServiceOperationResult;
 309         String serviceType = "";
 310         if (tempService) {
 311             deleteServiceOperationResult = this.serviceDataStoreOperations.deleteTempService(serviceName);
 312             serviceType = "Temp ";
 313         } else {
 314             deleteServiceOperationResult = this.serviceDataStoreOperations.deleteService(serviceName);
 315         }
 316         if (deleteServiceOperationResult.isSuccess()) {
 317             LOG.warn("{}Service was not removed from datastore!", serviceType);
 318         }
 319     }
 320
 321     @SuppressFBWarnings(
 322         value = "ES_COMPARING_STRINGS_WITH_EQ",
 323         justification = "false positives, not strings but real object references comparisons")
 324     private Boolean compareServiceRpcResultSp(RendererRpcResultSp notification) {
 325         if (serviceRpcResultSp == null
 326                 || serviceRpcResultSp.getNotificationType() != notification.getNotificationType()
 327                 || serviceRpcResultSp.getServiceName() != notification.getServiceName()
 328                 || serviceRpcResultSp.getStatus() != notification.getStatus()
 329                 || serviceRpcResultSp.getStatusMessage() != notification.getStatusMessage()) {
 330             return false;
 331         }
 332         return true;
 333     }
 334
 335     @Override
 336     public void setServiceInput(ServiceInput serviceInput) {
 337         this.input = serviceInput;
 338     }
 339
 340     @Override
 341     public void setserviceDataStoreOperations(ServiceDataStoreOperations serviceData) {
 342         this.serviceDataStoreOperations = serviceData;
 343     }
 344
 345     @Override
 346     public void setTempService(Boolean tempService) {
 347         this.tempService = tempService;
 348     }
 349
 350     /**
 351      * Send notification to NBI notification in order to publish message.
 352      * @param service PublishNotificationService
 353      */
 354     private void sendNbiNotification(PublishNotificationProcessService service) {
 355         try {
 356             notificationPublishService.putNotification(service);
 357         } catch (InterruptedException e) {
 358             LOG.warn("Cannot send notification to nbi", e);
 359             Thread.currentThread().interrupt();
 360         }
 361     }
 362
 363
 364     private void updateOtnTopology(RendererRpcResultSp notification, boolean isDeletion) {
 365         Link link = notification.getLink();
 366         if (link == null && notification.getLinkId() == null) {
 367             return;
 368         }
 369         List<String> supportedLinkIds = null;
 370         if (notification.getLinkId() != null) {
 371             supportedLinkIds = new ArrayList<>(notification.getLinkId());
 372         }
 373         String serviceType = notification.getServiceType();
 374         switch (serviceType) {
 375             case StringConstants.SERVICE_TYPE_OTU4:
 376             case StringConstants.SERVICE_TYPE_OTUC2:
 377             case StringConstants.SERVICE_TYPE_OTUC3:
 378             case StringConstants.SERVICE_TYPE_OTUC4:
 379             case StringConstants.SERVICE_TYPE_ODU4:
 380             case StringConstants.SERVICE_TYPE_ODUC2:
 381             case StringConstants.SERVICE_TYPE_ODUC3:
 382             case StringConstants.SERVICE_TYPE_ODUC4:
 383                 Map<String, OtnLinkType> otnLinkTypeMap = Map.of(
 384                     StringConstants.SERVICE_TYPE_OTU4, OtnLinkType.OTU4,
 385                     // TODO: need to change it when OtnLinkType is updated with enum
 386                     StringConstants.SERVICE_TYPE_OTUC2, OtnLinkType.OTUC4,
 387                     StringConstants.SERVICE_TYPE_OTUC3, OtnLinkType.OTUC4,
 388                     StringConstants.SERVICE_TYPE_OTUC4, OtnLinkType.OTUC4,
 389                     StringConstants.SERVICE_TYPE_ODU4, OtnLinkType.ODTU4,
 390                     // TODO: need to change it when OtnLinkType is updated with enum
 391                     StringConstants.SERVICE_TYPE_ODUC2, OtnLinkType.ODUC4,
 392                     StringConstants.SERVICE_TYPE_ODUC3, OtnLinkType.ODUC4,
 393                     StringConstants.SERVICE_TYPE_ODUC4, OtnLinkType.ODUC4);
 394                 if (isDeletion) {
 395                     LOG.info("updating otn-topology removing links");
 396                     this.networkModelService.deleteOtnLinks(link, supportedLinkIds, otnLinkTypeMap.get(serviceType));
 397                 } else {
 398                     LOG.info("updating otn-topology adding links");
 399                     this.networkModelService.createOtnLinks(link, supportedLinkIds, otnLinkTypeMap.get(serviceType));
 400                 }
 401                 break;
 402             case StringConstants.SERVICE_TYPE_1GE:
 403             case StringConstants.SERVICE_TYPE_10GE:
 404             case StringConstants.SERVICE_TYPE_100GE_M:
 405                 Short tribPort = Short.valueOf(notification.getAToZDirection().getMinTribSlot().getValue()
 406                     .split("\\.")[0]);
 407                 Short minTribSlot = Short.valueOf(notification.getAToZDirection().getMinTribSlot().getValue()
 408                     .split("\\.")[1]);
 409                 Short maxTribSlot = Short.valueOf(notification.getAToZDirection().getMaxTribSlot().getValue()
 410                     .split("\\.")[1]);
 411                 LOG.info("updating otn-topology node tps -tps and tpn pools");
 412                 this.networkModelService.updateOtnLinks(link, supportedLinkIds,
 413                     notification.getAToZDirection().getRate(), tribPort, minTribSlot, maxTribSlot, isDeletion);
 414                 break;
 415             case StringConstants.SERVICE_TYPE_100GE_S:
 416                 this.networkModelService.updateOtnLinks(supportedLinkIds, isDeletion);
 417                 break;
 418             default:
 419                 LOG.warn("service-type {} not managed yet", serviceType);
 420                 break;
 421         }
 422     }
 423
 424 }