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.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 IosXeRendererProvider, BindingAwareProvider {
  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
  63     public IosXeRendererProviderImpl(final DataBroker dataBroker, final BindingAwareBroker broker,
  64                                      final SxpEpProviderProvider sxpEpProvider) {
  65         LOG.debug("ios-xe renderer bootstrap");
  66         this.dataBroker = Preconditions.checkNotNull(dataBroker, "missing dataBroker dependency");
  67         this.sxpEpProvider = Preconditions.checkNotNull(sxpEpProvider, "missing sxpEpProvider param");
  68         broker.registerProvider(this);
  69     }
  70
  71     @Override
  72     public void close() {
  73         //TODO
  74         LOG.info("closing ios-xe renderer");
  75         if (rendererConfigurationListener != null) {
  76             rendererConfigurationListener.close();
  77         }
  78         if (iosXeCapableNodeListener != null) {
  79             iosXeCapableNodeListener.close();
  80         }
  81     }
  82
  83     @Override
  84     public void onSessionInitiated(final BindingAwareBroker.ProviderContext providerContext) {
  85         LOG.info("starting ios-xe renderer");
  86         //TODO register listeners:
  87         // node-manager
  88         final NodeManager nodeManager = new NodeManager(dataBroker, providerContext);
  89         // network-topology
  90         iosXeCapableNodeListener = new IosXeCapableNodeListenerImpl(dataBroker, nodeManager);
  91
  92         // policy-manager and delegates
  93         final PolicyManager policyManager = new PolicyManagerImpl(dataBroker, nodeManager, sxpEpProvider.getEPToSgtMapper());
  94         final PolicyManager policyManagerZip = new PolicyManagerZipImpl(policyManager);
  95
  96         // renderer-configuration endpoints
  97         rendererConfigurationListener = new RendererConfigurationListenerImpl(dataBroker, policyManagerZip);
  98         // supported node list maintenance
  99         // TODO: upkeep of available renderer-nodes
 100
 101         // provide renderer capabilities
 102         writeRendererCapabilities();
 103     }
 104
 105     private void writeRendererCapabilities() {
 106         final Optional<WriteTransaction> optionalWriteTransaction =
 107                 NetconfTransactionCreator.netconfWriteOnlyTransaction(dataBroker);
 108         if (!optionalWriteTransaction.isPresent()) {
 109             LOG.warn("Failed to create transaction, mountpoint: {}", dataBroker);
 110             return;
 111         }
 112         final WriteTransaction writeTransaction = optionalWriteTransaction.get();
 113         final ChainAction action = new ChainAction();
 114         final List<SupportedActionDefinition> actionDefinitions =
 115                 ImmutableList.of(new SupportedActionDefinitionBuilder().setActionDefinitionId(action.getId())
 116                         .setSupportedParameterValues(action.getSupportedParameterValues())
 117                         .build());
 118
 119         final Classifier etherClassifier = new EtherTypeClassifier(null);
 120         final Classifier ipProtoClassifier = new IpProtoClassifier(etherClassifier.getId());
 121         final List<SupportedClassifierDefinition> classifierDefinitions = ImmutableList
 122                 .of(new SupportedClassifierDefinitionBuilder().setClassifierDefinitionId(etherClassifier.getId())
 123                                 .setParentClassifierDefinitionId(etherClassifier.getParent())
 124                                 .setSupportedParameterValues(etherClassifier.getSupportedParameterValues())
 125                                 .build(),
 126                         new SupportedClassifierDefinitionBuilder().setClassifierDefinitionId(ipProtoClassifier.getId())
 127                                 .setParentClassifierDefinitionId(ipProtoClassifier.getParent())
 128                                 .setSupportedParameterValues(ipProtoClassifier.getSupportedParameterValues())
 129                                 .build());
 130
 131         final Renderer renderer = new RendererBuilder().setName(PolicyManagerImpl.IOS_XE_RENDERER)
 132                 .setCapabilities(new CapabilitiesBuilder().setSupportedActionDefinition(actionDefinitions)
 133                         .setSupportedClassifierDefinition(classifierDefinitions)
 134                         .build())
 135                 .build();
 136
 137         final InstanceIdentifier<Renderer> iid = InstanceIdentifier.builder(Renderers.class)
 138                 .child(Renderer.class, new RendererKey(new RendererName(PolicyManagerImpl.IOS_XE_RENDERER)))
 139                 .build();
 140         writeTransaction.merge(LogicalDatastoreType.OPERATIONAL, iid, renderer, true);
 141         final CheckedFuture<Void, TransactionCommitFailedException> future = writeTransaction.submit();
 142         Futures.addCallback(future, new FutureCallback<Void>() {
 143
 144             @Override
 145             public void onFailure(Throwable throwable) {
 146                 LOG.error("Could not register renderer {}: {}", renderer, throwable);
 147             }
 148
 149             @Override
 150             public void onSuccess(Void result) {
 151                 LOG.debug("Renderer {} successfully registered.", renderer);
 152             }
 153         });
 154     }
 155 }