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