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.nsa.cambria.backends;
24 import java.util.Collection;
27 * This is the factory class to instantiate the consumer
33 public interface ConsumerFactory {
34 public static final String kSetting_EnableCache = "cambria.consumer.cache.enabled";
35 public static boolean kDefault_IsCacheEnabled = true;
38 * User defined exception for Unavailable Exception
43 public class UnavailableException extends Exception {
45 * Unavailable Exception with message
49 public UnavailableException(String msg) {
54 * Unavailable Exception with the throwable object
58 public UnavailableException(Throwable t) {
63 * Unavailable Exception with the message and cause
68 public UnavailableException(String msg, Throwable cause) {
72 private static final long serialVersionUID = 1L;
76 * For admin use, drop all cached consumers.
78 public void dropCache();
81 * Get or create a consumer for the given set of info (topic, group, id)
84 * @param consumerGroupId
88 * @throws UnavailableException
90 public Consumer getConsumerFor(String topic, String consumerGroupId,
91 String clientId, int timeoutMs) throws UnavailableException;
94 * For factories that employ a caching mechanism, this allows callers to
95 * explicitly destory a consumer that resides in the factory's cache.
98 * @param consumerGroupId
101 public void destroyConsumer(String topic, String consumerGroupId,
105 * For admin/debug, we provide access to the consumers
107 * @return a collection of consumers
109 public Collection<? extends Consumer> getConsumers();