sxp-integration/sxp-ise-adapter/src/main/java/org/opendaylight/groupbasedpolicy/sxp_ise_adapter/impl/GbpIseSgtHarvesterImpl.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.sxp_ise_adapter.impl;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.util.concurrent.AsyncFunction;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.ThreadFactoryBuilder;
  16 import com.sun.jersey.api.client.Client;
  17 import com.sun.jersey.api.client.WebResource;
  18 import java.net.URI;
  19 import java.security.GeneralSecurityException;
  20 import java.util.ArrayList;
  21 import java.util.Collection;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Objects;
  25 import java.util.concurrent.Callable;
  26 import java.util.concurrent.ExecutorService;
  27 import java.util.concurrent.Executors;
  28 import java.util.concurrent.Future;
  29 import java.util.concurrent.TimeUnit;
  30 import java.util.stream.Collectors;
  31 import javax.annotation.Nonnull;
  32 import javax.annotation.Nullable;
  33 import javax.xml.xpath.XPath;
  34 import javax.xml.xpath.XPathExpressionException;
  35 import org.opendaylight.groupbasedpolicy.sxp_ise_adapter.impl.util.IseReplyUtil;
  36 import org.opendaylight.groupbasedpolicy.sxp_ise_adapter.impl.util.RestClientFactory;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ise.adapter.model.rev160630.gbp.sxp.ise.adapter.IseSourceConfig;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ise.adapter.model.rev160630.gbp.sxp.ise.adapter.ise.source.config.ConnectionConfig;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ise.adapter.model.rev160630.gbp.sxp.ise.adapter.ise.source.config.connection.config.Header;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.Sgt;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43 import org.w3c.dom.Node;
  44 import org.w3c.dom.NodeList;
  45 import org.xml.sax.InputSource;
  46
  47 /**
  48  * Purpose: harvest sgt + names available via ise-rest-api
  49  */
  50 public class GbpIseSgtHarvesterImpl implements GbpIseSgtHarvester {
  51
  52     private static final Logger LOG = LoggerFactory.getLogger(GbpIseSgtHarvesterImpl.class);
  53
  54     private final SgtInfoProcessor[] sgtInfoProcessors;
  55
  56     /**
  57      * @param sgtInfoProcessors generator delegate
  58      */
  59     public GbpIseSgtHarvesterImpl(final SgtInfoProcessor... sgtInfoProcessors) {
  60         this.sgtInfoProcessors = sgtInfoProcessors;
  61     }
  62
  63     @Override
  64     public ListenableFuture<Collection<SgtInfo>> harvestAll(@Nonnull final IseContext iseContext) {
  65         LOG.debug("ise-source: harvestAll {} -> {}", iseContext.getIseSourceConfig().getTenant(),
  66                 iseContext.getIseSourceConfig().getConnectionConfig().getIseRestUrl());
  67         ListenableFuture<Collection<SgtInfo>> result;
  68         try {
  69             final IseSourceConfig iseSourceConfig = iseContext.getIseSourceConfig();
  70             final ConnectionConfig connectionConfig = iseSourceConfig.getConnectionConfig();
  71             final WebResource baseWebResource = createWebResource(connectionConfig);
  72
  73             final WebResource.Builder requestBuilder = RestClientFactory.createRequestBuilder(baseWebResource,
  74                     connectionConfig.getHeader(), RestClientFactory.PATH_ERS_CONFIG_SGT);
  75             final String rawSgtSummary = IseReplyUtil.deliverResponse(requestBuilder);
  76
  77             final List<SgtInfo> sgtInfos = harvestDetails(rawSgtSummary, baseWebResource, connectionConfig, iseContext.getUuidToSgtMap());
  78
  79             ListenableFuture<Void> processingResult = Futures.immediateCheckedFuture(null);
  80             for (SgtInfoProcessor processor : sgtInfoProcessors) {
  81                 processingResult = Futures.transformAsync(processingResult, new AsyncFunction<Void, Void>() {
  82                     @Override
  83                     public ListenableFuture<Void> apply(final Void input) throws Exception {
  84                         LOG.debug("entering stg-info processor {}", processor.getClass().getSimpleName());
  85                         return processor.processSgtInfo(iseSourceConfig.getTenant(), sgtInfos);
  86                     }
  87                 });
  88             }
  89             result = Futures.transform(processingResult, new Function<Void, Collection<SgtInfo>>() {
  90                 @Nullable
  91                 @Override
  92                 public Collection<SgtInfo> apply(@Nullable final Void input) {
  93                     // update uuid map
  94                     for (SgtInfo sgtInfo : sgtInfos) {
  95                         iseContext.getUuidToSgtMap().put(sgtInfo.getUuid(), sgtInfo.getSgt().getValue());
  96                     }
  97                     //TODO: store harvest stats to DS/operational
  98                     // always success, otherwise there will be TransactionCommitFailedException thrown
  99                     return sgtInfos;
 100                 }
 101             });
 102         } catch (Exception e) {
 103             LOG.debug("failed to harvest ise", e);
 104             result = Futures.immediateFailedFuture(e);
 105         }
 106
 107         return result;
 108     }
 109
 110     private WebResource createWebResource(final ConnectionConfig connectionConfig) throws GeneralSecurityException {
 111         final Client iseClient = RestClientFactory.createIseClient(connectionConfig);
 112         return iseClient.resource(connectionConfig.getIseRestUrl().getValue());
 113     }
 114
 115     private List<SgtInfo> harvestDetails(final String rawSgtSummary, final WebResource baseWebResource,
 116                                          final ConnectionConfig connectionConfig, final Map<String, Integer> uuidToSgtMap) {
 117         LOG.trace("rawSgtSummary: {}", rawSgtSummary);
 118         final List<Future<SgtInfo>> sgtInfoFutureBag = new ArrayList<>();
 119
 120         // prepare worker pool
 121         final ExecutorService pool = Executors.newFixedThreadPool(
 122                 10, new ThreadFactoryBuilder().setNameFormat("ise-sgt-worker-%d").build());
 123
 124         // parse sgtSummary
 125         final XPath xpath = IseReplyUtil.setupXpath();
 126
 127         final InputSource inputSource = IseReplyUtil.createInputSource(rawSgtSummary);
 128         try {
 129             final NodeList sgtResources = IseReplyUtil.findAllSgtResourceNodes(xpath, inputSource);
 130             final Collection<Node> sgtLinkNodes = IseReplyUtil.filterNewResourcesByID(uuidToSgtMap, xpath, sgtResources);
 131
 132             int counter = 0;
 133             for (Node sgtLinkNode : sgtLinkNodes) {
 134                 final String sgtLinkHrefValue = sgtLinkNode.getNodeValue();
 135                 LOG.debug("found sgt resource: {}", sgtLinkHrefValue);
 136
 137                 // submit all query tasks to pool
 138                 final int idx = counter++;
 139                 sgtInfoFutureBag.add(pool.submit(new Callable<SgtInfo>() {
 140                     @Override
 141                     public SgtInfo call() {
 142                         SgtInfo sgtInfo = null;
 143                         try {
 144                             sgtInfo = querySgtDetail(baseWebResource, connectionConfig.getHeader(), xpath, idx, sgtLinkHrefValue);
 145                         } catch (XPathExpressionException e) {
 146                             LOG.info("failed to parse sgt response for {}: {}", sgtLinkHrefValue, e.getMessage());
 147                         }
 148                         return sgtInfo;
 149                     }
 150                 }));
 151             }
 152
 153             // stop pool
 154             pool.shutdown();
 155             final boolean terminated = pool.awaitTermination(1, TimeUnit.MINUTES);
 156             if (! terminated) {
 157                 LOG.debug("NOT all sgt-detail queries succeeded - timed out");
 158                 pool.shutdownNow();
 159             }
 160         } catch (InterruptedException | XPathExpressionException e) {
 161             LOG.warn("failed to query all-sgt details", e);
 162         }
 163
 164         // harvest available details
 165         return sgtInfoFutureBag.stream()
 166                 .map(this::gainSgtInfoSafely)
 167                 .filter(Objects::nonNull)
 168                 .collect(Collectors.toList());
 169     }
 170
 171     private SgtInfo gainSgtInfoSafely(final Future<SgtInfo> response) {
 172         SgtInfo result = null;
 173         if (response.isDone() && ! response.isCancelled()) {
 174             try {
 175                 result = response.get();
 176             } catch (Exception e) {
 177                 LOG.debug("sgt-detail query failed even when future was DONE", e);
 178             }
 179         }
 180         return result;
 181     }
 182
 183     private SgtInfo querySgtDetail(final WebResource baseWebResource, final List<Header> headers, final XPath xpath,
 184                                    final int idx, final String sgtLinkHrefValue) throws XPathExpressionException {
 185         // query all sgt entries (serial-vise)
 186         final URI hrefToSgtDetailUri = URI.create(sgtLinkHrefValue);
 187         final WebResource.Builder requestBuilder = RestClientFactory.createRequestBuilder(baseWebResource, headers,
 188                 hrefToSgtDetailUri.getPath());
 189         // time consuming operation - wait for rest response
 190         final String rawSgtDetail = IseReplyUtil.deliverResponse(requestBuilder);
 191         LOG.trace("rawSgtDetail: {}", rawSgtDetail);
 192
 193         // process response xml
 194         final Node sgtNode = IseReplyUtil.findSgtDetailNode(xpath, rawSgtDetail);
 195         final Node sgtName = IseReplyUtil.gainSgtName(xpath, sgtNode);
 196         final Node sgtUuid = IseReplyUtil.gainSgtUuid(xpath, sgtNode);
 197         final Node sgtValue = IseReplyUtil.gainSgtValue(xpath, sgtNode);
 198         LOG.debug("sgt value [{}]: {} -> {}", idx, sgtValue, sgtName);
 199
 200         // store replies into list of SgtInfo
 201         final Sgt sgt = new Sgt(Integer.parseInt(sgtValue.getNodeValue(), 10));
 202         return new SgtInfo(sgt, sgtName.getNodeValue(), sgtUuid.getNodeValue());
 203     }
 204
 205 }