renderers/ios-xe/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ios_xe_provider/impl/IosXeRendererProviderImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, 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
   9 package org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.util.concurrent.CheckedFuture;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17
  18 import java.util.List;
  19 import java.util.Optional;
  20
  21 import javax.annotation.Nonnull;
  22
  23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  24 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  27 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  28 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  29 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.api.manager.PolicyManager;
  30 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.listener.IosXeCapableNodeListenerImpl;
  31 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.listener.RendererConfigurationListenerImpl;
  32 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.NodeManager;
  33 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.PolicyManagerImpl;
  34 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.PolicyManagerZipImpl;
  35 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.writer.NetconfTransactionCreator;
  36 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.ChainAction;
  37 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.Classifier;
  38 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.EtherTypeClassifier;
  39 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.IpProtoClassifier;
  40 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.spi.SxpEpProviderProvider;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.RendererName;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.Renderers;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.Renderer;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.CapabilitiesBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedActionDefinition;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedActionDefinitionBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedClassifierDefinition;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedClassifierDefinitionBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.ip.sgt.distribution.rev160715.IpSgtDistributionService;
  52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 /**
  57  * Purpose: bootstrap provider implementation of Ios-xe renderer
  58  */
  59 public class IosXeRendererProviderImpl implements BindingAwareProvider, AutoCloseable {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(IosXeRendererProviderImpl.class);
  62
  63     private final DataBroker dataBroker;
  64     private final SxpEpProviderProvider sxpEpProvider;
  65     private RendererConfigurationListenerImpl rendererConfigurationListener;
  66     private IosXeCapableNodeListenerImpl iosXeCapableNodeListener;
  67     private final IpSgtDistributionService ipSgtDistributor;
  68
  69     public IosXeRendererProviderImpl(final DataBroker dataBroker, final BindingAwareBroker broker,
  70                                      final SxpEpProviderProvider sxpEpProvider,
  71                                      final IpSgtDistributionService ipSgtDistributor) {
  72         LOG.debug("ios-xe renderer bootstrap");
  73         this.dataBroker = Preconditions.checkNotNull(dataBroker, "missing dataBroker dependency");
  74         this.sxpEpProvider = Preconditions.checkNotNull(sxpEpProvider, "missing sxpEpProvider param");
  75         this.ipSgtDistributor = Preconditions.checkNotNull(ipSgtDistributor, "missing ipSgtDistributor param");
  76         broker.registerProvider(this);
  77     }
  78
  79     @Override
  80     public void close() {
  81         //TODO
  82         LOG.info("closing ios-xe renderer");
  83         if (rendererConfigurationListener != null) {
  84             rendererConfigurationListener.close();
  85         }
  86         if (iosXeCapableNodeListener != null) {
  87             iosXeCapableNodeListener.close();
  88         }
  89     }
  90
  91     @Override
  92     public void onSessionInitiated(final BindingAwareBroker.ProviderContext providerContext) {
  93         LOG.info("starting ios-xe renderer");
  94         //TODO register listeners:
  95         // node-manager
  96         final NodeManager nodeManager = new NodeManager(dataBroker, providerContext);
  97         // network-topology
  98         iosXeCapableNodeListener = new IosXeCapableNodeListenerImpl(dataBroker, nodeManager);
  99
 100         // policy-manager and delegates
 101         final PolicyManager policyManager = new PolicyManagerImpl(dataBroker, nodeManager, sxpEpProvider.getEPToSgtMapper(), ipSgtDistributor);
 102         final PolicyManager policyManagerZip = new PolicyManagerZipImpl(policyManager);
 103
 104         // renderer-configuration endpoints
 105         rendererConfigurationListener = new RendererConfigurationListenerImpl(dataBroker, policyManagerZip);
 106         // supported node list maintenance
 107         // TODO: upkeep of available renderer-nodes
 108
 109         // provide renderer capabilities
 110         writeRendererCapabilities();
 111     }
 112
 113     private void writeRendererCapabilities() {
 114         final Optional<WriteTransaction> optionalWriteTransaction =
 115                 NetconfTransactionCreator.netconfWriteOnlyTransaction(dataBroker);
 116         if (! optionalWriteTransaction.isPresent()) {
 117             LOG.warn("Failed to create transaction, mountpoint: {}", dataBroker);
 118             return;
 119         }
 120         final WriteTransaction writeTransaction = optionalWriteTransaction.get();
 121         final ChainAction action = new ChainAction();
 122         final List<SupportedActionDefinition> actionDefinitions =
 123                 ImmutableList.of(new SupportedActionDefinitionBuilder().setActionDefinitionId(action.getId())
 124                         .setSupportedParameterValues(action.getSupportedParameterValues())
 125                         .build());
 126
 127         final Classifier etherClassifier = new EtherTypeClassifier(null);
 128         final Classifier ipProtoClassifier = new IpProtoClassifier(etherClassifier.getId());
 129         final List<SupportedClassifierDefinition> classifierDefinitions = ImmutableList
 130                 .of(new SupportedClassifierDefinitionBuilder().setClassifierDefinitionId(etherClassifier.getId())
 131                                 .setParentClassifierDefinitionId(etherClassifier.getParent())
 132                                 .setSupportedParameterValues(etherClassifier.getSupportedParameterValues())
 133                                 .build(),
 134                         new SupportedClassifierDefinitionBuilder().setClassifierDefinitionId(ipProtoClassifier.getId())
 135                                 .setParentClassifierDefinitionId(ipProtoClassifier.getParent())
 136                                 .setSupportedParameterValues(ipProtoClassifier.getSupportedParameterValues())
 137                                 .build());
 138
 139         final Renderer renderer = new RendererBuilder().setName(PolicyManagerImpl.IOS_XE_RENDERER)
 140                 .setCapabilities(new CapabilitiesBuilder().setSupportedActionDefinition(actionDefinitions)
 141                         .setSupportedClassifierDefinition(classifierDefinitions)
 142                         .build())
 143                 .build();
 144
 145         final InstanceIdentifier<Renderer> iid = InstanceIdentifier.builder(Renderers.class)
 146                 .child(Renderer.class, new RendererKey(new RendererName(PolicyManagerImpl.IOS_XE_RENDERER)))
 147                 .build();
 148         writeTransaction.merge(LogicalDatastoreType.OPERATIONAL, iid, renderer, true);
 149         final CheckedFuture<Void, TransactionCommitFailedException> future = writeTransaction.submit();
 150         Futures.addCallback(future, new FutureCallback<Void>() {
 151
 152             @Override
 153             public void onFailure(@Nonnull Throwable throwable) {
 154                 LOG.error("Could not register renderer {}: {}", renderer, throwable);
 155             }
 156
 157             @Override
 158             public void onSuccess(Void result) {
 159                 LOG.debug("Renderer {} successfully registered.", renderer);
 160             }
 161         }, MoreExecutors.directExecutor());
 162     }
 163 }