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