blob: 5b2906f3c3eae15a28e741ffc88e99bbc5c18387 (
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/*-
* ============LICENSE_START=======================================================
* openECOMP : APP-C
* ================================================================================
* 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.openecomp.appc.listener;
import java.util.Collection;
import java.util.List;
import java.util.Set;
/**
* EventHandler defines a class that wraps DMaaP operations (most notably Get Message and Post Message) to make them
* easier to use.
*
*/
public interface EventHandler {
/**
* Gets a list of messages as Strings on the read topic.
*
* @return A list of String messages. Never returns null.
*/
public List<String> getIncomingEvents();
/**
* Gets a list of messages as String on the read topic.
*
* @param limit
* The maximum amount of entries to return
* @return A list of String messages. Never returns null.
*/
public List<String> getIncomingEvents(int limit);
/**
* Gets a list of messages Mapped to the given Class. If a message cannot be mapped to that class, it is discarded.
*
* @param cls
* The class to map the message to.
* @return A list of objects of the provided class. Never returns null.
*/
public <T> List<T> getIncomingEvents(Class<T> cls);
/**
* Gets a list of messages Mapped to the given Class. If a message cannot be mapped to that class, it is discarded.
*
* @param cls
* The class to map the message to.
* @param limit
* The maximum amount of entries to return
* @return A list of objects of the provided class. Never returns null.
*/
public <T> List<T> getIncomingEvents(Class<T> cls, int limit);
/**
* Posts the String message to the write topic(s).
*
* @param event
* The String to post.
*/
public void postStatus(String event);
/**
* Posts the String message to the write topic(s) on the specified partition. Partitions are only used to guarantee
* ordering and do not impact if data is retreived.
*
* @param partition
* The partition to post to or null if no partition should be used.
* @param event
* The String to post.
*/
public void postStatus(String partition, String event);
/**
* @return The client/group id used to read messages
*/
public String getClientId();
/**
* Set the client/group id used to read messages
*
* @param clientId
* The new clientId to use
*/
public void setClientId(String clientId);
/**
* @return The client/group name to use.
*/
public String getClientName();
/**
* Set the client/group name used to read messages.
*
* @param clientName
* The new clientName to use
*/
public void setClientName(String clientName);
/**
* @return The name of the topic to read from
*/
public String getReadTopic();
/**
* Set the name of the topic to read from.
*
* @param topic
* The new topic to read from
*/
public void setReadTopic(String topic);
/**
* @return The name of the topic to write to
*/
public Set<String> getWriteTopics();
/**
* Set the name of the topic to write to
*
* @param topic
* The new topic to write to
*/
public void setWriteTopics(Set<String> topic);
/**
* Adds a DMaaP host to the host pool
*
* @param host
* The host to add to the pool in <host>:<port> format
*/
public void addToPool(String host);
/**
* Remove the host name from the pool if it exists
*
* @param host
* The host to add to the pool in <host>:<port> format
*/
public void removeFromPool(String host);
/**
* Get all of the hosts in the DMaaP pool
*
* @return A collection of host in <host>:<port> format
*/
public Collection<String> getPool();
/**
* Clear any provided api credentials and make future requests as an unauthenticated user
*/
public void clearCredentials();
/**
* Set the api credentials and make future requests as an authenticated user
*
* @param access
* The access portion of the credentials (either user name or api key)
* @param secret
* The secret portion of the credentials (either password or api secret)
*/
public void setCredentials(String access, String secret);
/**
* Close consumer/producer DMaaP clients
*/
public void closeClients();
}
|
