aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/main/java/org/onap/policy/drools/event/comm/bus/BusTopicSource.java
blob: 4ef8e2d698409b2597ef88594ea3c28d5f922838 (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
74
75
76
77
78
79
80
81
82
83
/*-
 * ============LICENSE_START=======================================================
 * policy-endpoints
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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=========================================================
 */

package org.onap.policy.drools.event.comm.bus;

import org.onap.policy.drools.event.comm.TopicSource;

/**
 * Generic Topic Source for UEB/DMAAP Communication Infrastructure
 *
 */
public interface BusTopicSource extends ApiKeyEnabled, TopicSource {
	
	/**
	 * Default Consumer Instance Value
	 */
	public static String DEFAULT_CONSUMER_INSTANCE = "0";
	
	/**
	 * Default Timeout fetching in milliseconds
	 */
	public static int DEFAULT_TIMEOUT_MS_FETCH = 15000;
	
	/**
	 * Default maximum number of messages fetch at the time
	 */
	public static int DEFAULT_LIMIT_FETCH = 100;
	
	/**
	 * Definition of No Timeout fetching
	 */
	public static int NO_TIMEOUT_MS_FETCH = -1;
	
	/**
	 * Definition of No limit fetching
	 */
	public static int NO_LIMIT_FETCH = -1;
	
	/**
	 * gets the consumer group
	 * 
	 * @return consumer group
	 */
	public String getConsumerGroup();
	
	/**
	 * gets the consumer instance
	 * 
	 * @return consumer instance
	 */
	public String getConsumerInstance();
	
	/**
	 * gets the fetch timeout
	 * 
	 * @return fetch timeout
	 */
	public int getFetchTimeout();
	
	/**
	 * gets the fetch limit
	 * 
	 * @return fetch limit
	 */
	public int getFetchLimit();
}