aboutsummaryrefslogtreecommitdiffstats
path: root/sdc-distribution-client/src/main/java/org/openecomp/sdc/api/consumer/IConfiguration.java
blob: 51d219f51d718eda718f748507befa7e20800b7c (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
/*-
 * ============LICENSE_START=======================================================
 * sdc-distribution-client
 * ================================================================================
 * 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.sdc.api.consumer;

import java.util.List;
import org.openecomp.sdc.api.notification.INotificationData;

public interface IConfiguration {
	/**
	 * SDC Distribution Engine address. Value can be either hostname (with or
	 * without port), IP:port or FQDN (Fully Qualified Domain Name). * @return
	 * SDC Distribution Engine address.
	 */
	String getAsdcAddress();

	/**SDC Distribution Addresses from ONAP Component
	 * Values need to be set from impl
	 */
	List<String> getMsgBusAddress();

	/**
	 * User Name for SDC distribution consumer authentication.
	 * 
	 * @return User Name.
	 */
	String getUser();

	/**
	 * User Password for SDC distribution consumer authentication.
	 * 
	 * @return User Password.
	 */
	String getPassword();

	/**
	 * Distribution Client Polling Interval towards UEB in seconds. Can Be
	 * reconfigured in runtime.
	 * 
	 * @return Distribution Client Polling Interval.
	 */
	int getPollingInterval();

	/**
	 * Distribution Client Timeout in seconds waiting to UEB server response in
	 * each fetch interval. Can Be reconfigured in runtime.
	 * 
	 * @return Distribution Client Timeout in seconds.
	 */
	int getPollingTimeout();

	/**
	 * List of artifact types.<br>
	 * If the service contains any of the artifacts in the list, the callback
	 * will be activated. Can Be reconfigured in runtime.
	 * 
	 * @return List of artifact types.
	 */
	List<String> getRelevantArtifactTypes();

	/**
	 * Returns the consumer group defined for this ECOMP component, if no
	 * consumer group is defined return null.
	 * 
	 * @return Consumer group.
	 */
	String getConsumerGroup();

	/**
	 * Returns the environment name (testing, production etc...). Can Be
	 * reconfigured in runtime.
	 * 
	 * @return
	 */
	String getEnvironmentName();

	/**
	 * Unique ID of ECOMP component instance (e.x INSTAR name).
	 * 
	 * @return
	 */
	String getConsumerID();

	/**
	 * Return full path to Client's Key Store that contains either CA
	 * certificate or the ASDC's public key (e.g /etc/keystore/asdc-client.jks)
	 * file will be deployed with sdc-distribution jar.
	 * 
	 * @return
	 */
	String getKeyStorePath();

	/**
	 * @return Returns client's Key Store password
	 */
	String getKeyStorePassword();

	/**
	 * Sets whether SDC server TLS authentication is activated. If set to false,
	 * Key Store path and password are not needed to be set.
	 * 
	 * @return
	 */
	boolean activateServerTLSAuth();

	/**
	 * If set to true the method {@link INotificationData#getResources()} will
	 * return all found resources.<br>
	 * That means that metadata of resources that do not contain relevant
	 * artifacts types (artifacts that are defined in
	 * {@link #getRelevantArtifactTypes()} will be returned.<br>
	 * Setting the method to false will activate the legacy behavior, in which
	 * empty resources are not part of the notification.<br>
	 * 
	 * @return
	 */
	boolean isFilterInEmptyResources();

	/**
	 * By default, Distribution Client will use HTTPS (TLS 1.2) when connecting
	 * to DMAAP. This param can be null, then default (HTTPS) behavior will be
	 * applied. If set to false, distribution client will use HTTP when
	 * connecting to DMAAP.
	 * 
	 * @return
	 */
	Boolean isUseHttpsWithDmaap();

	/**
	 * By default, (false value) Distribution Client will trigger the regular registration
	 * towards SDC (register component as consumer to the SDC-DISTR-NOTIF-TOPIC-[ENV] topic and register component as producer to the SDC-DISTR-STATUS-TOPIC-[ENV]).<br>
	 * If set to true, distribution client trigger Register to SDC indicating
	 * that this component request to be consumer and producer of the
	 * SDC-DISTR-STATUS-TOPIC-[ENV] topic.<br>
	 * @return
	 */
	default boolean isConsumeProduceStatusTopic() {
		return false;
	}
}