blob: 4409e827ec590148cb1a29c18e0083c52c44b1fd (
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
|
/*
* ============LICENSE_START=======================================================
* policy-endpoints
* ================================================================================
* Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
* Modified Copyright (C) 2018 Samsung Electronics Co., Ltd.
* ================================================================================
* 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.common.endpoints.event.comm.bus;
import java.util.List;
import java.util.Properties;
import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
/**
* DMAAP Topic Sink Factory.
*/
public interface DmaapTopicSinkFactory {
/**
* <pre>
* Instantiate a new DMAAP Topic Sink, with following params.
* servers list of servers
* topic topic name
* apiKey API Key
* apiSecret API Secret
* userName AAF user name
* password AAF password
* partitionKey Consumer Group
* environment DME2 environment
* aftEnvironment DME2 AFT environment
* partner DME2 Partner
* latitude DME2 latitude
* longitude DME2 longitude
* additionalProps additional properties to pass to DME2
* managed is this sink endpoint managed?
* </pre>
* @param busTopicParams parameter object
* @return DmaapTopicSink object
* @throws IllegalArgumentException if invalid parameters are present
*/
DmaapTopicSink build(BusTopicParams busTopicParams);
/**
* Creates an DMAAP Topic Sink based on properties files.
*
* @param properties Properties containing initialization values
* @return an DMAAP Topic Sink
* @throws IllegalArgumentException if invalid parameters are present
*/
List<DmaapTopicSink> build(Properties properties);
/**
* Instantiates a new DMAAP Topic Sink.
*
* @param servers list of servers
* @param topic topic name
* @return an DMAAP Topic Sink
* @throws IllegalArgumentException if invalid parameters are present
*/
DmaapTopicSink build(List<String> servers, String topic);
/**
* Destroys an DMAAP Topic Sink based on a topic.
*
* @param topic topic name
* @throws IllegalArgumentException if invalid parameters are present
*/
void destroy(String topic);
/**
* Destroys all DMAAP Topic Sinks.
*/
void destroy();
/**
* Gets an DMAAP Topic Sink based on topic name.
*
* @param topic the topic name
* @return an DMAAP Topic Sink with topic name
* @throws IllegalArgumentException if an invalid topic is provided
* @throws IllegalStateException if the DMAAP Topic Reader is an incorrect state
*/
DmaapTopicSink get(String topic);
/**
* Provides a snapshot of the DMAAP Topic Sinks.
*
* @return a list of the DMAAP Topic Sinks
*/
List<DmaapTopicSink> inventory();
}
|
