2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * =============================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * ============LICENSE_END=========================================================
24 package org.onap.appc.adapter.message;
26 import java.util.List;
28 public interface Consumer {
31 * Gets a batch of messages from the topic. Defaults to 1000 messages with 15s wait for messages if empty.
33 * @return A list of strings representing the messages pulled from the topic.
38 * Gets a batch of messages from the topic.
41 * The amount of time to wait in milliseconds if the topic is empty for data to be written. Should be no
42 * less than 15000ms to prevent too many requests
44 * The amount of messages to fetch
45 * @return A list of strings representing the messages pulled from the topic.
47 List<String> fetch(int waitMs, int limit);
50 * Updates the api credentials for making authenticated requests.
53 * The public key to authenticate with
55 * The secret key to authenticate with
57 void updateCredentials(String apiKey, String apiSecret);
60 * Creates a dmaap client using a https connection
63 * True if https should be used, false otherwise.
65 default void useHttps(boolean yes) {}
68 * Sets Blacklist time for a server with response problem in seconds
70 default void setResponseProblemBlacklistTime(String duration) {}
73 * Sets Blacklist time for a server with server problem in seconds
75 default void setServerProblemBlacklistTime(String duration) {}
78 * Sets Blacklist time for a server with DNS problem in seconds
80 default void setDnsIssueBlacklistTime(String duration) {}
83 * Sets Blacklist time for a server with IO Exception problem in seconds
85 default void setIOExceptionBlacklistTime(String duration) {}
88 * Closes the dmaap client https connection.
90 default void close() {}