src/main/java/org/onap/dmaap/mr/client/MRClient.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 org.onap.dmaap.mr.client;
  23
  24 import org.slf4j.Logger;
  25
  26
  27 public interface MRClient
  28 {
  29         /**
  30          * An exception at the MR layer. This is used when the HTTP transport
  31          * layer returns a success code but the transaction is not completed as expected.
  32          */
  33         public class MRApiException extends Exception
  34         {
  35                 private static final long serialVersionUID = 1L;
  36                 public MRApiException ( String msg ) { super ( msg ); }
  37                 public MRApiException ( String msg, Throwable t ) { super ( msg, t ); }
  38         }
  39
  40         /**
  41          * Optionally set the Logger to use
  42          * @param log log
  43          */
  44         void logTo ( Logger log );
  45
  46         /**
  47          * Set the API credentials for this client connection. Subsequent calls will
  48          * include authentication headers.who i
  49          */
  50         /**
  51          * @param apiKey apikey
  52          * @param apiSecret apisec
  53          */
  54         void setApiCredentials ( String apiKey, String apiSecret );
  55
  56         /**
  57          * Remove API credentials, if any, on this connection. Subsequent calls will not include
  58          * authentication headers.
  59          */
  60         void clearApiCredentials ();
  61
  62         /**
  63          * Close this connection. Some client interfaces have additional close capability.
  64          */
  65         void close ();
  66 }