1 /*******************************************************************************
2 * ============LICENSE_START=======================================================
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
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=========================================================
19 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 *******************************************************************************/
22 package com.att.dmf.mr.backends;
24 import java.util.Collection;
25 import java.util.HashMap;
27 import com.att.dmf.mr.CambriaApiException;
30 * This is the factory class to instantiate the consumer
32 * @author nilanjana.maity
36 public interface ConsumerFactory {
37 public static final String kSetting_EnableCache = "cambria.consumer.cache.enabled";
38 public static boolean kDefault_IsCacheEnabled = true;
41 * User defined exception for Unavailable Exception
43 * @author nilanjana.maity
46 public class UnavailableException extends Exception {
48 * Unavailable Exception with message
52 public UnavailableException(String msg) {
57 * Unavailable Exception with the throwable object
61 public UnavailableException(Throwable t) {
66 * Unavailable Exception with the message and cause
71 public UnavailableException(String msg, Throwable cause) {
75 private static final long serialVersionUID = 1L;
79 * For admin use, drop all cached consumers.
81 public void dropCache();
84 * Get or create a consumer for the given set of info (topic, group, id)
87 * @param consumerGroupId
91 * @throws UnavailableException
93 //public Consumer getConsumerFor(String topic, String consumerGroupId,
94 // String clientId, int timeoutMs) throws UnavailableException;
97 * For factories that employ a caching mechanism, this allows callers to
98 * explicitly destory a consumer that resides in the factory's cache.
101 * @param consumerGroupId
104 public void destroyConsumer(String topic, String consumerGroupId,
108 * For admin/debug, we provide access to the consumers
110 * @return a collection of consumers
112 public Collection<? extends Consumer> getConsumers();
114 public Consumer getConsumerFor(String topic, String consumerGroupName, String consumerId, int timeoutMs, String remotehost) throws UnavailableException, CambriaApiException;
115 public HashMap getConsumerForKafka011(String topic, String consumerGroupName, String consumerId, int timeoutMs, String remotehost) throws UnavailableException, CambriaApiException;