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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*-
* ============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.onap.sdc.api;
import java.util.List;
import org.onap.sdc.api.consumer.*;
import org.onap.sdc.api.results.IDistributionClientDownloadResult;
import org.onap.sdc.api.results.IDistributionClientResult;
import org.onap.sdc.api.consumer.*;
import org.onap.sdc.api.notification.IArtifactInfo;
import org.onap.sdc.api.notification.IVfModuleMetadata;
public interface IDistributionClient {
/**
* Update the configuration of the distribution client <br>
* Updatable configuration parameters are: pollingInterval, pollingTimeout,
* consumerGroup and relevantArtifactTypes
*
* @param newConf
* - contains updated configuration
*
* @return IDistributionClientResult
*/
IDistributionClientResult updateConfiguration(IConfiguration newConf);
/**
* Retrieve the configuration of the distribution client <br>
*
* @return IConfiguration
*/
IConfiguration getConfiguration();
/**
* Start distribution client <br>
* - start polling notification topic <br>
*
* @return IDistributionClientResult
*/
IDistributionClientResult start();
/**
* Stop distribution client <br>
* - stop polling notification topic <br>
* - unregister topics (via ASDC) <br>
* - delete keys from UEB
*
* @return IDistributionClientResult
*/
IDistributionClientResult stop();
/**
* Downloads an artifact from ASDC Catalog <br>
*
* @param artifactInfo
* @return IDistributionClientDownloadResult
*/
IDistributionClientDownloadResult download(IArtifactInfo artifactInfo);
/**
* Initialize the distribution client <br>
* - fetch the UEB server list from ASDC <br>
* - create keys in UEB <br>
* - register for topics (via ASDC) <br>
* - set the notification callback <br>
*
* Note: all configuration fields are mandatory. <br>
* Password must be in clear text and not encrypted <br>
* ONAP-Component MUST store password as SHA-2 (256) hashed with
* dynamically generated salt value <br>
*
* @param conf
* @param callback
* @return IDistributionClientResult
*/
IDistributionClientResult init(IConfiguration conf, INotificationCallback callback);
/**
* Initialize the distribution client <br>
* - fetch the UEB server list from ASDC <br>
* - create keys in UEB <br>
* - register for topics (via ASDC) <br>
* - set the notification callback <br>
*
* Note: all configuration fields are mandatory. <br>
* Password must be in clear text and not encrypted <br>
* ONAP-Component MUST store password as SHA-2 (256) hashed with
* dynamically generated salt value <br>
*
* @param conf
* @param notificationCallback
* @param statusCallback
* @return IDistributionClientResult
*/
IDistributionClientResult init(IConfiguration conf, INotificationCallback notificationCallback,
IStatusCallback statusCallback);
/**
* Build and publish Distribution Download Status event to Distribution
* Status Topic
*
* @param statusMessage
* @return IDistributionClientResult
*/
IDistributionClientResult sendDownloadStatus(IDistributionStatusMessage statusMessage);
/**
* Build and publish Distribution Download Status event to Distribution
* Status Topic With Error Reason.
*
* @param statusMessage
* @param errorReason
* @return IDistributionClientResult
*/
IDistributionClientResult sendDownloadStatus(IDistributionStatusMessage statusMessage, String errorReason);
/**
* Build and publish Distribution Deployment Status event to Distribution
* Status Topic
*
* @param statusMessage
* @return IDistributionClientResult
*/
IDistributionClientResult sendDeploymentStatus(IDistributionStatusMessage statusMessage);
/**
* Build and publish Distribution Deployment Status event to Distribution
* Status Topic With Error Reason.
*
* @param statusMessage
* @param errorReason
* @return IDistributionClientResult
*/
IDistributionClientResult sendDeploymentStatus(IDistributionStatusMessage statusMessage, String errorReason);
/**
* Build and publish Distribution Component Status event to Distribution
* Status Topic
*
* @param statusMessage
* @return IDistributionClientResult
*/
IDistributionClientResult sendComponentDoneStatus(IComponentDoneStatusMessage statusMessage);
/**
* Build and publish Distribution Component Status event to Distribution
* Status Topic With Error Reason.
*
* @param statusMessage
* @param errorReason
* @return IDistributionClientResult
*/
IDistributionClientResult sendComponentDoneStatus(IComponentDoneStatusMessage statusMessage, String errorReason);
/**
* Build and publish Distribution Final Status event to Distribution
* Status Topic
*
* @param statusMessage
* @return IDistributionClientResult
*/
IDistributionClientResult sendFinalDistrStatus(IFinalDistrStatusMessage statusMessage);
/**
* Build and publish Distribution Final Status event to Distribution
* Status Topic With Error Reason.
*
* @param statusMessage
* @param errorReason
* @return IDistributionClientResult
*/
IDistributionClientResult sendFinalDistrStatus(IFinalDistrStatusMessage statusMessage, String errorReason);
/**
* This method parses artifact of type VF_MODULES_METADATA payload data
* .<br>
* Method is deprecated due to VF Module changes. Only backward
* compatibility is supported.<br>
*
* @param artifactPayload
* @return IVfModuleMetadata list
*/
@Deprecated
List<IVfModuleMetadata> decodeVfModuleArtifact(byte[] artifactPayload);
}
|
