2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl;
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 org.opendaylight.controller.md.sal.binding.api.DataBroker;
17 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
20 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
21 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
22 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.api.IosXeRendererProvider;
23 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.api.manager.PolicyManager;
24 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.listener.IosXeCapableNodeListenerImpl;
25 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.listener.RendererConfigurationListenerImpl;
26 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.NodeManager;
27 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.PolicyManagerImpl;
28 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.PolicyManagerZipImpl;
29 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.writer.NetconfTransactionCreator;
30 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.ChainAction;
31 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.Classifier;
32 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.EtherTypeClassifier;
33 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.sf.IpProtoClassifier;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.RendererName;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.Renderers;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.Renderer;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererKey;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.CapabilitiesBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedActionDefinition;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedActionDefinitionBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedClassifierDefinition;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedClassifierDefinitionBuilder;
44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 import java.util.List;
49 import java.util.Optional;
52 * Purpose: bootstrap provider implementation of Ios-xe renderer
54 public class IosXeRendererProviderImpl implements IosXeRendererProvider, BindingAwareProvider {
56 private static final Logger LOG = LoggerFactory.getLogger(IosXeRendererProviderImpl.class);
58 private final DataBroker dataBroker;
59 private final RendererName rendererName;
60 private RendererConfigurationListenerImpl rendererConfigurationListener;
61 private IosXeCapableNodeListenerImpl iosXeCapableNodeListener;
63 public IosXeRendererProviderImpl(final DataBroker dataBroker, final BindingAwareBroker broker,
64 final RendererName rendererName) {
65 LOG.debug("ios-xe renderer bootstrap");
66 this.dataBroker = Preconditions.checkNotNull(dataBroker, "missing dataBroker dependency");
67 this.rendererName = Preconditions.checkNotNull(rendererName, "missing rendererName param");
68 broker.registerProvider(this);
74 LOG.info("closing ios-xe renderer");
75 if (rendererConfigurationListener != null) {
76 rendererConfigurationListener.close();
78 if (iosXeCapableNodeListener != null) {
79 iosXeCapableNodeListener.close();
84 public void onSessionInitiated(final BindingAwareBroker.ProviderContext providerContext) {
85 LOG.info("starting ios-xe renderer");
86 //TODO register listeners:
88 final NodeManager nodeManager = new NodeManager(dataBroker, providerContext);
90 iosXeCapableNodeListener = new IosXeCapableNodeListenerImpl(dataBroker, nodeManager);
92 // policy-manager and delegates
93 final PolicyManager policyManager = new PolicyManagerImpl(dataBroker, nodeManager);
94 final PolicyManager policyManagerZip = new PolicyManagerZipImpl(policyManager);
96 // renderer-configuration endpoints
97 rendererConfigurationListener = new RendererConfigurationListenerImpl(dataBroker, rendererName, policyManagerZip);
98 // supported node list maintenance
99 // TODO: upkeep of available renderer-nodes
101 // provide renderer capabilities
102 writeRendererCapabilities();
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);
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())
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())
126 new SupportedClassifierDefinitionBuilder().setClassifierDefinitionId(ipProtoClassifier.getId())
127 .setParentClassifierDefinitionId(ipProtoClassifier.getParent())
128 .setSupportedParameterValues(ipProtoClassifier.getSupportedParameterValues())
131 final Renderer renderer = new RendererBuilder().setName(NodeManager.iosXeRenderer)
132 .setCapabilities(new CapabilitiesBuilder().setSupportedActionDefinition(actionDefinitions)
133 .setSupportedClassifierDefinition(classifierDefinitions)
137 final InstanceIdentifier<Renderer> iid = InstanceIdentifier.builder(Renderers.class)
138 .child(Renderer.class, new RendererKey(new RendererName(NodeManager.iosXeRenderer)))
140 writeTransaction.merge(LogicalDatastoreType.OPERATIONAL, iid, renderer, true);
141 final CheckedFuture<Void, TransactionCommitFailedException> future = writeTransaction.submit();
142 Futures.addCallback(future, new FutureCallback<Void>() {
145 public void onFailure(Throwable throwable) {
146 LOG.error("Could not register renderer {}: {}", renderer, throwable);
150 public void onSuccess(Void result) {
151 LOG.debug("Renderer {} successfully registered.", renderer);