aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/dmaap/mr/client/MRClient.java
blob: f1a642b953ba0a6bb6f0a0ef0c30eff3e8a9f088 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*******************************************************************************
 *  ============LICENSE_START=======================================================
 *  org.onap.dmaap
 *  ================================================================================
 *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 *  ================================================================================
 *  Modifications Copyright © 2021 Orange.
 *  ================================================================================
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  ============LICENSE_END=========================================================
 *
 *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
 *
 *******************************************************************************/

package org.onap.dmaap.mr.client;

import org.slf4j.Logger;


public interface MRClient {
    /**
     * An exception at the MR layer. This is used when the HTTP transport
     * layer returns a success code but the transaction is not completed as expected.
     */
    class MRApiException extends Exception {
        private static final long serialVersionUID = 1L;

        public MRApiException(String msg) {
            super(msg);
        }

        public MRApiException(String msg, Throwable t) {
            super(msg, t);
        }
    }

    /**
     * Optionally set the Logger to use.
     *
     * @param log log
     */
    void logTo(Logger log);

    /**
     * Set the API credentials for this client connection. Subsequent calls will
     * include authentication headers.who i
     *
     * @param apiKey    apikey
     * @param apiSecret apisec
     */
    void setApiCredentials(String apiKey, String apiSecret);

    /**
     * Remove API credentials, if any, on this connection. Subsequent calls will not include
     * authentication headers.
     */
    void clearApiCredentials();

    /**
     * Close this connection. Some client interfaces have additional close capability.
     */
    void close();
}