src/main/java/com/att/dmf/mr/metrics/publisher/CambriaClient.java

   1 /*******************************************************************************
   2  *  ============LICENSE_START=======================================================
   3  *  org.onap.dmaap
   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  *        http://www.apache.org/licenses/LICENSE-2.0
  11 *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *  ============LICENSE_END=========================================================
  18  *
  19  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20  *
  21  *******************************************************************************/
  22 package com.att.dmf.mr.metrics.publisher;
  23
  24
  25
  26 //
  27 import com.att.eelf.configuration.EELFLogger;
  28
  29
  30 /**
  31  *
  32  * @author anowarul.islam
  33  *
  34  */
  35 public interface CambriaClient {
  36         /**
  37          * An exception at the Cambria layer. This is used when the HTTP transport
  38          * layer returns a success code but the transaction is not completed as
  39          * expected.
  40          */
  41         public class CambriaApiException extends Exception {
  42                 /**
  43                  *
  44                  * @param msg
  45                  */
  46                 public CambriaApiException(String msg) {
  47                         super(msg);
  48                 }
  49
  50                 /**
  51                  *
  52                  * @param msg
  53                  * @param t
  54                  */
  55                 public CambriaApiException(String msg, Throwable t) {
  56                         super(msg, t);
  57                 }
  58
  59                 private static final long serialVersionUID = 1L;
  60         }
  61
  62         /**
  63          * Optionally set the Logger to use
  64          *
  65          * @param log
  66          */
  67         void logTo(EELFLogger  log);
  68
  69         /**
  70          * Set the API credentials for this client connection. Subsequent calls will
  71          *  include authentication headers.who i
  72          *
  73          * @param apiKey
  74          * @param apiSecret
  75          */
  76         void setApiCredentials(String apiKey, String apiSecret);
  77
  78         /**
  79          * Remove API credentials, if any, on this connection. Subsequent calls will
  80          * not include authentication headers.
  81          */
  82         void clearApiCredentials();
  83
  84         /**
  85          * Close this connection. Some client interfaces have additional close
  86          * capability.
  87          */
  88         void close();
  89 }