src/main/java/org/onap/aai/sparky/dal/aai/ActiveInventoryAdapter.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23 package org.onap.aai.sparky.dal.aai;
  24
  25 import java.io.IOException;
  26 import java.net.URLEncoder;
  27 import java.nio.ByteBuffer;
  28 import java.util.List;
  29 import java.util.NoSuchElementException;
  30
  31 import org.apache.http.client.utils.URIBuilder;
  32 import org.onap.aai.sparky.config.oxm.OxmEntityDescriptor;
  33 import org.onap.aai.sparky.config.oxm.OxmModelLoader;
  34 import org.onap.aai.sparky.dal.aai.config.ActiveInventoryConfig;
  35 import org.onap.aai.sparky.dal.aai.config.ActiveInventoryRestConfig;
  36 import org.onap.aai.sparky.dal.aai.enums.RestAuthenticationMode;
  37 import org.onap.aai.sparky.dal.exception.ElasticSearchOperationException;
  38 import org.onap.aai.sparky.dal.rest.OperationResult;
  39 import org.onap.aai.sparky.dal.rest.RestClientBuilder;
  40 import org.onap.aai.sparky.dal.rest.RestfulDataAccessor;
  41 import org.onap.aai.sparky.logging.AaiUiMsgs;
  42 import org.onap.aai.sparky.security.SecurityContextFactory;
  43 import org.onap.aai.sparky.util.NodeUtils;
  44 import org.onap.aai.cl.api.Logger;
  45 import org.onap.aai.cl.eelf.LoggerFactory;
  46
  47 import com.sun.jersey.api.client.Client;
  48 import com.sun.jersey.api.client.WebResource.Builder;
  49
  50
  51 /**
  52  * The Class ActiveInventoryAdapter.
  53  */
  54
  55 /**
  56  * @author davea
  57  *
  58  */
  59 public class ActiveInventoryAdapter extends RestfulDataAccessor
  60     implements ActiveInventoryDataProvider {
  61
  62   private static final Logger LOG =
  63       LoggerFactory.getInstance().getLogger(ActiveInventoryAdapter.class);
  64
  65   private static final String HEADER_TRANS_ID = "X-TransactionId";
  66   private static final String HEADER_FROM_APP_ID = "X-FromAppId";
  67   private static final String HEADER_AUTHORIZATION = "Authorization";
  68
  69   private static final String TRANSACTION_ID_PREFIX = "txnId-";
  70   private static final String UI_APP_NAME = "AAI-UI";
  71
  72
  73   private ActiveInventoryConfig config;
  74
  75   /**
  76    * Instantiates a new active inventory adapter.
  77    *
  78    * @param restClientBuilder the rest client builder
  79    * @throws ElasticSearchOperationException the elastic search operation exception
  80    * @throws IOException Signals that an I/O exception has occurred.
  81    */
  82   public ActiveInventoryAdapter(RestClientBuilder restClientBuilder)
  83       throws ElasticSearchOperationException, IOException {
  84     super(restClientBuilder);
  85
  86     try {
  87       this.config = ActiveInventoryConfig.getConfig();
  88     } catch (Exception exc) {
  89       throw new ElasticSearchOperationException("Error getting active inventory configuration",
  90           exc);
  91     }
  92
  93     clientBuilder.setUseHttps(true);
  94
  95     clientBuilder.setValidateServerHostname(config.getAaiSslConfig().isValidateServerHostName());
  96
  97     SecurityContextFactory sslContextFactory = clientBuilder.getSslContextFactory();
  98
  99     sslContextFactory.setServerCertificationChainValidationEnabled(
 100         config.getAaiSslConfig().isValidateServerCertificateChain());
 101
 102     if (config.getAaiRestConfig().getAuthenticationMode() == RestAuthenticationMode.SSL_CERT) {
 103       sslContextFactory.setClientCertFileName(config.getAaiSslConfig().getKeystoreFilename());
 104       sslContextFactory.setClientCertPassword(config.getAaiSslConfig().getKeystorePassword());
 105       sslContextFactory.setTrustStoreFileName(config.getAaiSslConfig().getTruststoreFilename());
 106     }
 107
 108     clientBuilder.setConnectTimeoutInMs(config.getAaiRestConfig().getConnectTimeoutInMs());
 109     clientBuilder.setReadTimeoutInMs(config.getAaiRestConfig().getReadTimeoutInMs());
 110
 111   }
 112
 113   /* (non-Javadoc)
 114    * @see org.onap.aai.sparky.dal.rest.RestfulDataAccessor#setClientDefaults(com.sun.jersey.api.client.Client, java.lang.String, java.lang.String, java.lang.String)
 115    */
 116   @Override
 117   protected Builder setClientDefaults(Client client, String url, String payloadContentType,
 118       String acceptContentType) {
 119     Builder builder = super.setClientDefaults(client, url, payloadContentType, acceptContentType);
 120
 121     builder = builder.header(HEADER_FROM_APP_ID, UI_APP_NAME);
 122     byte bytes[] = new byte[6];
 123     txnIdGenerator.nextBytes(bytes);
 124     builder =
 125         builder.header(HEADER_TRANS_ID, TRANSACTION_ID_PREFIX + ByteBuffer.wrap(bytes).getInt());
 126
 127     if (config.getAaiRestConfig().getAuthenticationMode() == RestAuthenticationMode.SSL_BASIC) {
 128       builder = builder.header(HEADER_AUTHORIZATION,
 129           config.getAaiSslConfig().getBasicAuthenticationCredentials());
 130     }
 131
 132     return builder;
 133   }
 134
 135   /**
 136    * The main method.
 137    *
 138    * @param args the arguments
 139    */
 140   public static void main(String[] args) {
 141
 142     // TODO Auto-generated method stub
 143     RestClientBuilder builder = new RestClientBuilder();
 144     RestfulDataAccessor accessor;
 145     try {
 146       accessor = new ActiveInventoryAdapter(builder);
 147       OperationResult or =
 148           accessor.doGet("/cloud-infrastructure/pservers/pserver/SQLTEST006", "application/json");
 149       String jsonPatch = "{ \"hostname\" : \"SQLTEST006\", \"prov-status\" : \"PREPROV\","
 150           + " \"in-maint\" : \"false\", \"is-closed-loop\" : \"false\" }";
 151       or = accessor.doPatch("/cloud-infrastructure/pservers/pserver/SQLTEST006", jsonPatch,
 152           "application/json");
 153       // System.out.println("PATCH or = " + or.getResultCode() + " : " + or.toString());
 154     } catch (ElasticSearchOperationException | IOException exc) {
 155       // TODO Auto-generated catch block
 156       exc.printStackTrace();
 157     }
 158
 159   }
 160
 161   /**
 162    * Gets the full url.
 163    *
 164    * @param resourceUrl the resource url
 165    * @return the full url
 166    * @throws Exception the exception
 167    */
 168   private String getFullUrl(String resourceUrl) throws Exception {
 169     ActiveInventoryRestConfig aaiRestConfig = ActiveInventoryConfig.getConfig().getAaiRestConfig();
 170     final String host = aaiRestConfig.getHost();
 171     final String port = aaiRestConfig.getPort();
 172     final String basePath = aaiRestConfig.getResourceBasePath();
 173     return String.format("https://%s:%s%s%s", host, port, basePath, resourceUrl);
 174   }
 175
 176   public String getGenericQueryForSelfLink(String startNodeType, List<String> queryParams) throws Exception {
 177
 178     URIBuilder urlBuilder = new URIBuilder(getFullUrl("/search/generic-query"));
 179
 180     for( String queryParam : queryParams) {
 181       urlBuilder.addParameter("key", queryParam);
 182     }
 183
 184     urlBuilder.addParameter("start-node-type", startNodeType);
 185     urlBuilder.addParameter("include", startNodeType);
 186
 187     final String constructedLink = urlBuilder.toString();
 188
 189     // TODO: debug log for constructed link
 190
 191     return constructedLink;
 192
 193 }
 194
 195
 196   /* (non-Javadoc)
 197    * @see org.onap.aai.sparky.dal.aai.ActiveInventoryDataProvider#getSelfLinksByEntityType(java.lang.String)
 198    */
 199   @Override
 200   public OperationResult getSelfLinksByEntityType(String entityType) throws Exception {
 201
 202     /*
 203      * For this one, I want to dynamically construct the nodes-query for self-link discovery as a
 204      * utility method that will use the OXM model entity data to drive the query as well.
 205      */
 206
 207     if (entityType == null) {
 208       throw new NullPointerException(
 209           "Failed to getSelfLinksByEntityType() because entityType is null");
 210     }
 211
 212     OxmEntityDescriptor entityDescriptor =
 213         OxmModelLoader.getInstance().getEntityDescriptor(entityType);
 214
 215     if (entityDescriptor == null) {
 216       throw new NoSuchElementException("Failed to getSelfLinksByEntityType() because could"
 217           + " not find entity descriptor from OXM with type = " + entityType);
 218     }
 219
 220     String link = null;
 221     final String primaryKeyStr =
 222         NodeUtils.concatArray(entityDescriptor.getPrimaryKeyAttributeName(), "/");
 223
 224     link = getFullUrl("/search/nodes-query?search-node-type=" + entityType + "&filter="
 225         + primaryKeyStr + ":EXISTS");
 226
 227
 228
 229     return doGet(link, "application/json");
 230
 231   }
 232
 233   /* (non-Javadoc)
 234    * @see org.onap.aai.sparky.dal.aai.ActiveInventoryDataProvider#getSelfLinkForEntity(java.lang.String, java.lang.String, java.lang.String)
 235    */
 236   @Override
 237   public OperationResult getSelfLinkForEntity(String entityType, String primaryKeyName,
 238       String primaryKeyValue) throws Exception {
 239
 240     if (entityType == null) {
 241       throw new NullPointerException("Failed to getSelfLinkForEntity() because entityType is null");
 242     }
 243
 244     if (primaryKeyName == null) {
 245       throw new NullPointerException(
 246           "Failed to getSelfLinkForEntity() because primaryKeyName is null");
 247     }
 248
 249     if (primaryKeyValue == null) {
 250       throw new NullPointerException(
 251           "Failed to getSelfLinkForEntity() because primaryKeyValue is null");
 252     }
 253
 254
 255     /*
 256      * Try to protect ourselves from illegal URI formatting exceptions caused by characters that
 257      * aren't natively supported in a URI, but can be escaped to make them legal.
 258      */
 259
 260     String encodedEntityType = URLEncoder.encode(entityType, "UTF-8");
 261     String encodedPrimaryKeyName = URLEncoder.encode(primaryKeyName, "UTF-8");
 262     String encodedPrimaryKeyValue = URLEncoder.encode(primaryKeyValue, "UTF-8");
 263
 264     String link = null;
 265
 266     if ("service-instance".equals(entityType)) {
 267
 268       link = getFullUrl("/search/generic-query?key=" + encodedEntityType + "."
 269           + encodedPrimaryKeyName + ":" + encodedPrimaryKeyValue + "&start-node-type="
 270           + encodedEntityType + "&include=customer&depth=2");
 271
 272     } else {
 273
 274       link =
 275           getFullUrl("/search/generic-query?key=" + encodedEntityType + "." + encodedPrimaryKeyName
 276               + ":" + encodedPrimaryKeyValue + "&start-node-type=" + encodedEntityType);
 277
 278     }
 279
 280     return queryActiveInventoryWithRetries(link, "application/json",
 281         this.config.getAaiRestConfig().getNumRequestRetries());
 282
 283   }
 284
 285
 286   /**
 287    * Our retry conditions should be very specific.
 288    *
 289    * @param r the r
 290    * @return true, if successful
 291    */
 292   private boolean shouldRetryRequest(OperationResult r) {
 293
 294     if (r == null) {
 295       return true;
 296     }
 297
 298     int rc = r.getResultCode();
 299
 300     if (rc == 200) {
 301       return false;
 302     }
 303
 304     if (rc == 404) {
 305       return false;
 306     }
 307
 308     return true;
 309
 310   }
 311
 312   /**
 313    * Query active inventory.
 314    *
 315    * @param url the url
 316    * @param acceptContentType the accept content type
 317    * @return the operation result
 318    */
 319   // package protected for test classes instead of private
 320   OperationResult queryActiveInventory(String url, String acceptContentType) {
 321     return doGet(url, acceptContentType);
 322   }
 323
 324   /* (non-Javadoc)
 325    * @see org.onap.aai.sparky.dal.aai.ActiveInventoryDataProvider#queryActiveInventoryWithRetries(java.lang.String, java.lang.String, int)
 326    */
 327   @Override
 328   public OperationResult queryActiveInventoryWithRetries(String url, String responseType,
 329       int numRetries) {
 330
 331     OperationResult result = null;
 332
 333     for (int x = 0; x < numRetries; x++) {
 334
 335       LOG.debug(AaiUiMsgs.QUERY_AAI_RETRY_SEQ, url, String.valueOf(x + 1));
 336
 337       result = queryActiveInventory(url, responseType);
 338
 339       /**
 340        * Record number of times we have attempted the request to later summarize how many times we
 341        * are generally retrying over thousands of messages in a sync.
 342        *
 343        * If the number of retries is surprisingly high, then we need to understand why that is as
 344        * the number of retries is also causing a heavier load on AAI beyond the throttling controls
 345        * we already have in place in term of the transaction rate controller and number of
 346        * parallelized threads per task processor.
 347        */
 348
 349       result.setNumRequestRetries(x);
 350
 351       if (!shouldRetryRequest(result)) {
 352
 353         /*
 354          * if (myConfig.getAaiRestConfig().isCacheEnabled()) {
 355          *
 356          * CachedHttpRequest cachedRequest = new CachedHttpRequest();
 357          * cachedRequest.setHttpRequestMethod("GET"); cachedRequest.setPayload("");
 358          * cachedRequest.setPayloadMimeType(""); cachedRequest.setUrl(url);
 359          * cachedRequest.setOperationType( TransactionStorageType.ACTIVE_INVENTORY_QUERY.getIndex()
 360          * );
 361          *
 362          * CachedHttpResponse cachedResponse = new CachedHttpResponse();
 363          * cachedResponse.setPayload(result.getResult());
 364          * cachedResponse.setPayloadMimeType("application/json");
 365          * cachedResponse.setStatusCode(result.getResultCode());
 366          *
 367          * CachedHttpTransaction txn = new CachedHttpTransaction(cachedRequest, cachedResponse);
 368          * storageProvider.persistTransaction(txn);
 369          *
 370          * }
 371          */
 372
 373
 374         result.setResolvedLinkFromServer(true);
 375         LOG.debug(AaiUiMsgs.QUERY_AAI_RETRY_DONE_SEQ, url, String.valueOf(x + 1));
 376
 377         return result;
 378       }
 379
 380       try {
 381         /*
 382          * Sleep between re-tries to be nice to the target system.
 383          */
 384         Thread.sleep(50);
 385       } catch (InterruptedException exc) {
 386         LOG.error(AaiUiMsgs.QUERY_AAI_WAIT_INTERRUPTION, exc.getLocalizedMessage());
 387         break;
 388       }
 389       LOG.error(AaiUiMsgs.QUERY_AAI_RETRY_FAILURE_WITH_SEQ, url, String.valueOf(x + 1));
 390     }
 391
 392
 393     result.setResolvedLinkFailure(true);
 394     LOG.info(AaiUiMsgs.QUERY_AAI_RETRY_MAXED_OUT, url);
 395
 396     return result;
 397
 398   }
 399
 400   /* (non-Javadoc)
 401    * @see org.onap.aai.sparky.dal.rest.RestfulDataAccessor#shutdown()
 402    */
 403   @Override
 404   public void shutdown() {
 405     // TODO Auto-generated method stub
 406
 407     if (entityCache != null) {
 408       entityCache.shutdown();
 409     }
 410
 411   }
 412
 413
 414 }