dcae-analytics-aai/src/main/java/org/onap/dcae/apod/analytics/aai/service/AAIEnrichmentClient.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   4  * ================================================================================
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *   You may obtain a copy of the License at
  10  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.onap.dcae.apod.analytics.aai.service;
  22
  23 import java.util.Map;
  24
  25 /**
  26  * <p>
  27  * A client used to get enrichment details from A&AI
  28  * </p>
  29  *
  30  * @author Rajiv Singla . Creation Date: 9/15/2017.
  31  */
  32 public interface AAIEnrichmentClient {
  33
  34     /**
  35      * Provides enrichment details from A&AI API and returns them as string. If no enrichment lookup fails returns null
  36      *
  37      * @param aaiAPIPath A&AI API Path
  38      * @param queryParams A&AI Query Params map
  39      * @param headers A&AI HTTP Headers
  40      *
  41      * @return Enrichment details from A&AI API and returns them as string. If enrichment lookup fails returns null
  42      */
  43     String getEnrichmentDetails(String aaiAPIPath, Map<String, String> queryParams, Map<String, String> headers);
  44
  45 }