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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
|
/*-
* ============LICENSE_START=======================================================
* ONAP : APPC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Copyright (C) 2017 Amdocs
* =============================================================================
* 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.
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
* ============LICENSE_END=========================================================
*/
/*
* NOTE: This file is auto-generated and should not be changed manually.
*/
package org.openecomp.appc.client.lcm.api;
import org.openecomp.appc.client.lcm.model.AuditOutput;
import org.openecomp.appc.client.lcm.model.AuditInput;
import org.openecomp.appc.client.lcm.model.CheckLockOutput;
import org.openecomp.appc.client.lcm.model.CheckLockInput;
import org.openecomp.appc.client.lcm.model.ConfigBackupOutput;
import org.openecomp.appc.client.lcm.model.ConfigBackupInput;
import org.openecomp.appc.client.lcm.model.ConfigBackupDeleteOutput;
import org.openecomp.appc.client.lcm.model.ConfigBackupDeleteInput;
import org.openecomp.appc.client.lcm.model.ConfigExportOutput;
import org.openecomp.appc.client.lcm.model.ConfigExportInput;
import org.openecomp.appc.client.lcm.model.ConfigModifyOutput;
import org.openecomp.appc.client.lcm.model.ConfigModifyInput;
import org.openecomp.appc.client.lcm.model.ConfigRestoreOutput;
import org.openecomp.appc.client.lcm.model.ConfigRestoreInput;
import org.openecomp.appc.client.lcm.model.ConfigScaleoutOutput;
import org.openecomp.appc.client.lcm.model.ConfigScaleoutInput;
import org.openecomp.appc.client.lcm.model.ConfigureOutput;
import org.openecomp.appc.client.lcm.model.ConfigureInput;
import org.openecomp.appc.client.lcm.model.EvacuateOutput;
import org.openecomp.appc.client.lcm.model.EvacuateInput;
import org.openecomp.appc.client.lcm.model.HealthCheckOutput;
import org.openecomp.appc.client.lcm.model.HealthCheckInput;
import org.openecomp.appc.client.lcm.model.LiveUpgradeOutput;
import org.openecomp.appc.client.lcm.model.LiveUpgradeInput;
import org.openecomp.appc.client.lcm.model.LockOutput;
import org.openecomp.appc.client.lcm.model.LockInput;
import org.openecomp.appc.client.lcm.model.MigrateOutput;
import org.openecomp.appc.client.lcm.model.MigrateInput;
import org.openecomp.appc.client.lcm.model.RebuildOutput;
import org.openecomp.appc.client.lcm.model.RebuildInput;
import org.openecomp.appc.client.lcm.model.RestartOutput;
import org.openecomp.appc.client.lcm.model.RestartInput;
import org.openecomp.appc.client.lcm.model.RollbackOutput;
import org.openecomp.appc.client.lcm.model.RollbackInput;
import org.openecomp.appc.client.lcm.model.SnapshotOutput;
import org.openecomp.appc.client.lcm.model.SnapshotInput;
import org.openecomp.appc.client.lcm.model.SoftwareUploadOutput;
import org.openecomp.appc.client.lcm.model.SoftwareUploadInput;
import org.openecomp.appc.client.lcm.model.StartOutput;
import org.openecomp.appc.client.lcm.model.StartInput;
import org.openecomp.appc.client.lcm.model.StopOutput;
import org.openecomp.appc.client.lcm.model.StopInput;
import org.openecomp.appc.client.lcm.model.SyncOutput;
import org.openecomp.appc.client.lcm.model.SyncInput;
import org.openecomp.appc.client.lcm.model.TerminateOutput;
import org.openecomp.appc.client.lcm.model.TerminateInput;
import org.openecomp.appc.client.lcm.model.TestOutput;
import org.openecomp.appc.client.lcm.model.TestInput;
import org.openecomp.appc.client.lcm.model.UnlockOutput;
import org.openecomp.appc.client.lcm.model.UnlockInput;
import org.openecomp.appc.RPC;
import org.openecomp.appc.client.lcm.exceptions.AppcClientException;
/**
* Defines the services and request/response requirements for the ECOMP APP-C
* component.
*/
@javax.annotation.Generated(value = {
"templates/client-kit/open-api-to-java.ftl" }, date = "2017-05-04T20:09:01.723+05:30", comments = "Auto-generated from Open API specification")
public interface LifeCycleManagerStateful {
/**
* The Audit command compares the configuration of the VNF associated with the
* current request against the configuration that is stored in APPC's
* configuration store. A successful Audit means that the current VNF
* configuration matches the APPC stored configuration. A failed Audit indicates
* that the request configuration is different from the stored configuration.
* This command can be applied to any VNF type. The only restriction is that a
* particular VNF should be able to support the interface for Reading
* Configuration using existing adapters and use the following protocols: CLI,
* RestConf and XML. The Audit action does not require any payload parameters
*
* @param auditInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "audit", outputType = AuditOutput.class)
AuditOutput audit(AuditInput auditInput) throws AppcClientException;
/**
* The Audit command compares the configuration of the VNF associated with the
* current request against the configuration that is stored in APPC's
* configuration store. A successful Audit means that the current VNF
* configuration matches the APPC stored configuration. A failed Audit indicates
* that the request configuration is different from the stored configuration.
* This command can be applied to any VNF type. The only restriction is that a
* particular VNF should be able to support the interface for Reading
* Configuration using existing adapters and use the following protocols: CLI,
* RestConf and XML. The Audit action does not require any payload parameters
*
* @param auditInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "audit", outputType = AuditOutput.class)
void audit(AuditInput auditInput, ResponseHandler<AuditOutput> listener) throws AppcClientException;
/**
* The CheckLock command returns true if the specified VNF is locked, false if
* not. A CheckLock command is deemed successful if the processing completes
* without error, whether the VNF is locked or not. The command returns only a
* single response with a final status. The APPC also locks the target VNF
* during any command processing, so a VNF can have a locked status even if no
* Lock command has been explicitly called. The CheckLock command returns a
* specific response structure that extends the default LCM response. The
* CheckLock action does not require any payload parameters
*
* @param checkLockInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "check-lock", outputType = CheckLockOutput.class)
CheckLockOutput checkLock(CheckLockInput checkLockInput) throws AppcClientException;
/**
* The CheckLock command returns true if the specified VNF is locked, false if
* not. A CheckLock command is deemed successful if the processing completes
* without error, whether the VNF is locked or not. The command returns only a
* single response with a final status. The APPC also locks the target VNF
* during any command processing, so a VNF can have a locked status even if no
* Lock command has been explicitly called. The CheckLock command returns a
* specific response structure that extends the default LCM response. The
* CheckLock action does not require any payload parameters
*
* @param checkLockInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "check-lock", outputType = CheckLockOutput.class)
void checkLock(CheckLockInput checkLockInput, ResponseHandler<CheckLockOutput> listener) throws AppcClientException;
/**
* An operation to Backup configurations of a virtual network function (or VM)
*
* @param configBackupInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-backup", outputType = ConfigBackupOutput.class)
ConfigBackupOutput configBackup(ConfigBackupInput configBackupInput) throws AppcClientException;
/**
* An operation to Backup configurations of a virtual network function (or VM)
*
* @param configBackupInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-backup", outputType = ConfigBackupOutput.class)
void configBackup(ConfigBackupInput configBackupInput, ResponseHandler<ConfigBackupOutput> listener)
throws AppcClientException;
/**
* An operation to Delete backup configurations of a virtual network function
* (or VM)
*
* @param configBackupDeleteInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-backup-delete", outputType = ConfigBackupDeleteOutput.class)
ConfigBackupDeleteOutput configBackupDelete(ConfigBackupDeleteInput configBackupDeleteInput)
throws AppcClientException;
/**
* An operation to Delete backup configurations of a virtual network function
* (or VM)
*
* @param configBackupDeleteInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-backup-delete", outputType = ConfigBackupDeleteOutput.class)
void configBackupDelete(ConfigBackupDeleteInput configBackupDeleteInput,
ResponseHandler<ConfigBackupDeleteOutput> listener) throws AppcClientException;
/**
* An operation to Export configurations of a virtual network function (or VM)
*
* @param configExportInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-export", outputType = ConfigExportOutput.class)
ConfigExportOutput configExport(ConfigExportInput configExportInput) throws AppcClientException;
/**
* An operation to Export configurations of a virtual network function (or VM)
*
* @param configExportInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-export", outputType = ConfigExportOutput.class)
void configExport(ConfigExportInput configExportInput, ResponseHandler<ConfigExportOutput> listener)
throws AppcClientException;
/**
* Use the ModifyConfig command when a full configuration cycle is either not
* required or is considered too costly. The ModifyConfig LCM action affects
* only a subset of the total configuration data of a VNF. The set of
* configuration parameters to be affected is a subset of the total
* configuration data of the target VNF type. The payload block must contain the
* configuration parameters to be modified and their values. A successful modify
* returns a success response. A failed modify returns a failure response and
* the specific failure messages in the response payload block
*
* @param configModifyInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-modify", outputType = ConfigModifyOutput.class)
ConfigModifyOutput configModify(ConfigModifyInput configModifyInput) throws AppcClientException;
/**
* Use the ModifyConfig command when a full configuration cycle is either not
* required or is considered too costly. The ModifyConfig LCM action affects
* only a subset of the total configuration data of a VNF. The set of
* configuration parameters to be affected is a subset of the total
* configuration data of the target VNF type. The payload block must contain the
* configuration parameters to be modified and their values. A successful modify
* returns a success response. A failed modify returns a failure response and
* the specific failure messages in the response payload block
*
* @param configModifyInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-modify", outputType = ConfigModifyOutput.class)
void configModify(ConfigModifyInput configModifyInput, ResponseHandler<ConfigModifyOutput> listener)
throws AppcClientException;
/**
* An operation to restore the configurations of a virtual network function (or
* VM)
*
* @param configRestoreInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-restore", outputType = ConfigRestoreOutput.class)
ConfigRestoreOutput configRestore(ConfigRestoreInput configRestoreInput) throws AppcClientException;
/**
* An operation to restore the configurations of a virtual network function (or
* VM)
*
* @param configRestoreInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-restore", outputType = ConfigRestoreOutput.class)
void configRestore(ConfigRestoreInput configRestoreInput, ResponseHandler<ConfigRestoreOutput> listener)
throws AppcClientException;
/**
* An operation to scaleout the configurations of a virtual network function (or
* VM)
*
* @param configScaleoutInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-scaleout", outputType = ConfigScaleoutOutput.class)
ConfigScaleoutOutput configScaleout(ConfigScaleoutInput configScaleoutInput) throws AppcClientException;
/**
* An operation to scaleout the configurations of a virtual network function (or
* VM)
*
* @param configScaleoutInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "config-scaleout", outputType = ConfigScaleoutOutput.class)
void configScaleout(ConfigScaleoutInput configScaleoutInput, ResponseHandler<ConfigScaleoutOutput> listener)
throws AppcClientException;
/**
* An operation to configure the configurations of a virtual network function
* (or VM)
*
* @param configureInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "configure", outputType = ConfigureOutput.class)
ConfigureOutput configure(ConfigureInput configureInput) throws AppcClientException;
/**
* An operation to configure the configurations of a virtual network function
* (or VM)
*
* @param configureInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "configure", outputType = ConfigureOutput.class)
void configure(ConfigureInput configureInput, ResponseHandler<ConfigureOutput> listener) throws AppcClientException;
/**
* An operation to evacuate a virtual network function (or VM)
*
* @param evacuateInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "evacuate", outputType = EvacuateOutput.class)
EvacuateOutput evacuate(EvacuateInput evacuateInput) throws AppcClientException;
/**
* An operation to evacuate a virtual network function (or VM)
*
* @param evacuateInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "evacuate", outputType = EvacuateOutput.class)
void evacuate(EvacuateInput evacuateInput, ResponseHandler<EvacuateOutput> listener) throws AppcClientException;
/**
* This command runs a VNF health check and returns the result. A health check
* is VNF-specific. For a complex VNF, APPC initiates further subordinate health
* checks
*
* @param healthCheckInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "health-check", outputType = HealthCheckOutput.class)
HealthCheckOutput healthCheck(HealthCheckInput healthCheckInput) throws AppcClientException;
/**
* This command runs a VNF health check and returns the result. A health check
* is VNF-specific. For a complex VNF, APPC initiates further subordinate health
* checks
*
* @param healthCheckInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "health-check", outputType = HealthCheckOutput.class)
void healthCheck(HealthCheckInput healthCheckInput, ResponseHandler<HealthCheckOutput> listener)
throws AppcClientException;
/**
* The LiveUpgrade LCM action upgrades the target VNF to a new version without
* interrupting VNF operation. A successful upgrade returns a success status. A
* failed upgrade returns a failure code and the failure messages in the
* response payload block. The payload includes the IP of the location that
* hosts the new software version installer file and the new software version.
* Connections or operations that are active at the time of the LiveUpgrade
* action request will not be interrupted by the action and, therefore, the
* action may take a significant amount of time to run. A LiveUpgrade is defined
* as non-disruptive; it is the responsibility of the VNF to handle disruptions
* if they occur
*
* @param liveUpgradeInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "live-upgrade", outputType = LiveUpgradeOutput.class)
LiveUpgradeOutput liveUpgrade(LiveUpgradeInput liveUpgradeInput) throws AppcClientException;
/**
* The LiveUpgrade LCM action upgrades the target VNF to a new version without
* interrupting VNF operation. A successful upgrade returns a success status. A
* failed upgrade returns a failure code and the failure messages in the
* response payload block. The payload includes the IP of the location that
* hosts the new software version installer file and the new software version.
* Connections or operations that are active at the time of the LiveUpgrade
* action request will not be interrupted by the action and, therefore, the
* action may take a significant amount of time to run. A LiveUpgrade is defined
* as non-disruptive; it is the responsibility of the VNF to handle disruptions
* if they occur
*
* @param liveUpgradeInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "live-upgrade", outputType = LiveUpgradeOutput.class)
void liveUpgrade(LiveUpgradeInput liveUpgradeInput, ResponseHandler<LiveUpgradeOutput> listener)
throws AppcClientException;
/**
* Use the Lock command to ensure exclusive access during a series of critical
* LCM commands. The Lock action will return a successful result if the VNF is
* not already locked or if it was locked with the same request-id, otherwise
* the action returns a response with a reject status code. When a VNF is
* locked, any subsequent sequential commands with same request-id will be
* accepted. Commands associated with other request-ids will be rejected. The
* Lock command returns only one final response with the status of the request
* processing. The APPC also locks the target VNF during any command processing.
* If a lock action is then requested on that VNF, it will be rejected because
* the VNF was already locked, even though no actual lock command was explicitly
* invoked
*
* @param lockInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "lock", outputType = LockOutput.class)
LockOutput lock(LockInput lockInput) throws AppcClientException;
/**
* Use the Lock command to ensure exclusive access during a series of critical
* LCM commands. The Lock action will return a successful result if the VNF is
* not already locked or if it was locked with the same request-id, otherwise
* the action returns a response with a reject status code. When a VNF is
* locked, any subsequent sequential commands with same request-id will be
* accepted. Commands associated with other request-ids will be rejected. The
* Lock command returns only one final response with the status of the request
* processing. The APPC also locks the target VNF during any command processing.
* If a lock action is then requested on that VNF, it will be rejected because
* the VNF was already locked, even though no actual lock command was explicitly
* invoked
*
* @param lockInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "lock", outputType = LockOutput.class)
void lock(LockInput lockInput, ResponseHandler<LockOutput> listener) throws AppcClientException;
/**
* Migrates a running target VFC from its current AIC host to another. A
* destination AIC node will be selected by relying on AIC internal rules to
* migrate. A successful Migrate action returns a success response and the new
* AIC node identity in the response payload block. A failed Migrate action
* returns a failure and the failure messages in the response payload block
*
* @param migrateInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "migrate", outputType = MigrateOutput.class)
MigrateOutput migrate(MigrateInput migrateInput) throws AppcClientException;
/**
* Migrates a running target VFC from its current AIC host to another. A
* destination AIC node will be selected by relying on AIC internal rules to
* migrate. A successful Migrate action returns a success response and the new
* AIC node identity in the response payload block. A failed Migrate action
* returns a failure and the failure messages in the response payload block
*
* @param migrateInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "migrate", outputType = MigrateOutput.class)
void migrate(MigrateInput migrateInput, ResponseHandler<MigrateOutput> listener) throws AppcClientException;
/**
* Recreates a target VFC instance to a known, stable state. A successful
* rebuild returns a success response and the rebuild details in the response
* payload block. A failed rebuild returns a failure and the failure messages in
* the response payload block
*
* @param rebuildInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "rebuild", outputType = RebuildOutput.class)
RebuildOutput rebuild(RebuildInput rebuildInput) throws AppcClientException;
/**
* Recreates a target VFC instance to a known, stable state. A successful
* rebuild returns a success response and the rebuild details in the response
* payload block. A failed rebuild returns a failure and the failure messages in
* the response payload block
*
* @param rebuildInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "rebuild", outputType = RebuildOutput.class)
void rebuild(RebuildInput rebuildInput, ResponseHandler<RebuildOutput> listener) throws AppcClientException;
/**
* An operation to restart a virtual network function (or VM)
*
* @param restartInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "restart", outputType = RestartOutput.class)
RestartOutput restart(RestartInput restartInput) throws AppcClientException;
/**
* An operation to restart a virtual network function (or VM)
*
* @param restartInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "restart", outputType = RestartOutput.class)
void restart(RestartInput restartInput, ResponseHandler<RestartOutput> listener) throws AppcClientException;
/**
* Sets a VNF to the previous version of the configuration without explicitly
* invoking the configuration set name. This command is used when the
* configuration was successful, but the health-check was not. A successful
* rollback returns a success status when the restart process has completed. A
* failed or a partially failed (for a complex VNF) rollback returns a failure
* and the failure messages in the response payload block. This command can be
* applied to any VNF type. The only restriction is that the particular VNF
* should be built based on the generic heap stack
*
* @param rollbackInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "rollback", outputType = RollbackOutput.class)
RollbackOutput rollback(RollbackInput rollbackInput) throws AppcClientException;
/**
* Sets a VNF to the previous version of the configuration without explicitly
* invoking the configuration set name. This command is used when the
* configuration was successful, but the health-check was not. A successful
* rollback returns a success status when the restart process has completed. A
* failed or a partially failed (for a complex VNF) rollback returns a failure
* and the failure messages in the response payload block. This command can be
* applied to any VNF type. The only restriction is that the particular VNF
* should be built based on the generic heap stack
*
* @param rollbackInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "rollback", outputType = RollbackOutput.class)
void rollback(RollbackInput rollbackInput, ResponseHandler<RollbackOutput> listener) throws AppcClientException;
/**
* Creates a snapshot of a VNF, or VM. The Snapshot command returns a customized
* response containing a reference to the newly created snapshot instance if the
* action is successful. This command can be applied to any VNF type. The only
* restriction is that the particular VNF should be built based on the generic
* heap stack
*
* @param snapshotInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "snapshot", outputType = SnapshotOutput.class)
SnapshotOutput snapshot(SnapshotInput snapshotInput) throws AppcClientException;
/**
* Creates a snapshot of a VNF, or VM. The Snapshot command returns a customized
* response containing a reference to the newly created snapshot instance if the
* action is successful. This command can be applied to any VNF type. The only
* restriction is that the particular VNF should be built based on the generic
* heap stack
*
* @param snapshotInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "snapshot", outputType = SnapshotOutput.class)
void snapshot(SnapshotInput snapshotInput, ResponseHandler<SnapshotOutput> listener) throws AppcClientException;
/**
* This LCM command uploads the file that contains a new software version to the
* target VNF
*
* @param softwareUploadInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "software-upload", outputType = SoftwareUploadOutput.class)
SoftwareUploadOutput softwareUpload(SoftwareUploadInput softwareUploadInput) throws AppcClientException;
/**
* This LCM command uploads the file that contains a new software version to the
* target VNF
*
* @param softwareUploadInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "software-upload", outputType = SoftwareUploadOutput.class)
void softwareUpload(SoftwareUploadInput softwareUploadInput, ResponseHandler<SoftwareUploadOutput> listener)
throws AppcClientException;
/**
* An operation to start a virtual network function (or VM)
*
* @param startInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "start", outputType = StartOutput.class)
StartOutput start(StartInput startInput) throws AppcClientException;
/**
* An operation to start a virtual network function (or VM)
*
* @param startInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "start", outputType = StartOutput.class)
void start(StartInput startInput, ResponseHandler<StartOutput> listener) throws AppcClientException;
/**
* Stop a target VNF or VNFC. A successful stop returns a success response. For
* a multi-component stop to be considered successful, all component stop
* actions must succeed. A failed stop returns a failure and the failure
* messages in the response payload block
*
* @param stopInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "stop", outputType = StopOutput.class)
StopOutput stop(StopInput stopInput) throws AppcClientException;
/**
* Stop a target VNF or VNFC. A successful stop returns a success response. For
* a multi-component stop to be considered successful, all component stop
* actions must succeed. A failed stop returns a failure and the failure
* messages in the response payload block
*
* @param stopInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "stop", outputType = StopOutput.class)
void stop(StopInput stopInput, ResponseHandler<StopOutput> listener) throws AppcClientException;
/**
* The Sync action updates the current configuration in the APPC store with the
* running configuration from the device. A successful Sync returns a success
* status. A failed Sync returns a failure response status and failure messages
* in the response payload block. This command can be applied to any VNF type.
* The only restriction is that a particular VNF should be able to support the
* interface for Reading Configuration using existing adapters and use the
* following protocols: CLI, RestConf and XML
*
* @param syncInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "sync", outputType = SyncOutput.class)
SyncOutput sync(SyncInput syncInput) throws AppcClientException;
/**
* The Sync action updates the current configuration in the APPC store with the
* running configuration from the device. A successful Sync returns a success
* status. A failed Sync returns a failure response status and failure messages
* in the response payload block. This command can be applied to any VNF type.
* The only restriction is that a particular VNF should be able to support the
* interface for Reading Configuration using existing adapters and use the
* following protocols: CLI, RestConf and XML
*
* @param syncInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "sync", outputType = SyncOutput.class)
void sync(SyncInput syncInput, ResponseHandler<SyncOutput> listener) throws AppcClientException;
/**
* Terminate a target VNF and release its resources (possibly gracefully).
* Specific scripts can be run before termination by placing them under the
* Terminate life cycle event. All configuration files related to the target VNF
* are deleted. The resources of a terminated VNF that are not managed by APPC,
* such as those handled by SDNC or other components, are not handled and remain
* the responsibility of their respective managing functions. A successful
* Terminate action returns a success response. For a multi-component terminate
* to be considered successful, all component Terminate actions must also
* succeed. A failed Terminate returns a failure status and the failure messages
* in the response payload block
*
* @param terminateInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "terminate", outputType = TerminateOutput.class)
TerminateOutput terminate(TerminateInput terminateInput) throws AppcClientException;
/**
* Terminate a target VNF and release its resources (possibly gracefully).
* Specific scripts can be run before termination by placing them under the
* Terminate life cycle event. All configuration files related to the target VNF
* are deleted. The resources of a terminated VNF that are not managed by APPC,
* such as those handled by SDNC or other components, are not handled and remain
* the responsibility of their respective managing functions. A successful
* Terminate action returns a success response. For a multi-component terminate
* to be considered successful, all component Terminate actions must also
* succeed. A failed Terminate returns a failure status and the failure messages
* in the response payload block
*
* @param terminateInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "terminate", outputType = TerminateOutput.class)
void terminate(TerminateInput terminateInput, ResponseHandler<TerminateOutput> listener) throws AppcClientException;
/**
* The Test LCM action checks a target VNF or VNFC for correct operation. The
* functionality of the Test LCM action involves should involve more than a
* HealthCheck , it should provide a means for launching a test transaction and
* determining if the transaction completed successfully or not. A transaction
* launcher microservice will have to be supplied by the VNF and called by APPC.
* A successful test returns a success and the results of the test in the
* payload block. A failed test returns a failure and specific failure messages
* in the payload block
*
* @param testInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "test", outputType = TestOutput.class)
TestOutput test(TestInput testInput) throws AppcClientException;
/**
* The Test LCM action checks a target VNF or VNFC for correct operation. The
* functionality of the Test LCM action involves should involve more than a
* HealthCheck , it should provide a means for launching a test transaction and
* determining if the transaction completed successfully or not. A transaction
* launcher microservice will have to be supplied by the VNF and called by APPC.
* A successful test returns a success and the results of the test in the
* payload block. A failed test returns a failure and specific failure messages
* in the payload block
*
* @param testInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "test", outputType = TestOutput.class)
void test(TestInput testInput, ResponseHandler<TestOutput> listener) throws AppcClientException;
/**
* Run the Unlock command to release the lock on a VNF and allow other clients
* to perform LCM commands on that VNF. The Unlock command will result in
* success if the VNF successfully unlocked or if it was already unlocked,
* otherwise commands will be rejected. The Unlock command will only return
* success if the VNF was locked with same request-id (on page 6). The Unlock
* command returns only one final response with the status of the request
* processing. The APPC also locks the target VNF during any command processing.
* If an Unlock action is then requested on that VNF with a different
* request-id, it will be rejected because the VNF is already locked for another
* process, even though no actual lock command was explicitly invoked
*
* @param unlockInput
* - RPC input object
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "unlock", outputType = UnlockOutput.class)
UnlockOutput unlock(UnlockInput unlockInput) throws AppcClientException;
/**
* Run the Unlock command to release the lock on a VNF and allow other clients
* to perform LCM commands on that VNF. The Unlock command will result in
* success if the VNF successfully unlocked or if it was already unlocked,
* otherwise commands will be rejected. The Unlock command will only return
* success if the VNF was locked with same request-id (on page 6). The Unlock
* command returns only one final response with the status of the request
* processing. The APPC also locks the target VNF during any command processing.
* If an Unlock action is then requested on that VNF with a different
* request-id, it will be rejected because the VNF is already locked for another
* process, even though no actual lock command was explicitly invoked
*
* @param unlockInput
* - RPC input object
* @param listener
* - callback implementation
* @throws AppcClientException
* - throw AppcClientException
*/
@RPC(name = "unlock", outputType = UnlockOutput.class)
void unlock(UnlockInput unlockInput, ResponseHandler<UnlockOutput> listener) throws AppcClientException;
}
|