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