aboutsummaryrefslogtreecommitdiffstats
path: root/sdc-distribution-client/src/main/java/org/onap/sdc/api/notification/IVfModuleMetadata.java
blob: 5347189dd6cd602857df17df431fbd20c3e480eb (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
/*-
 * ============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.notification;

import java.util.List;

/**
 * VF Module in the resource (VF) context
 */
public interface IVfModuleMetadata {
    /**
     * Logical VF  Module Name. Unique Identifier of  VF Module in the resource (VF) context.<br>
     * Ex. : "PCRF-module-0"
     */
    String getVfModuleModelName();

    /**
     * Invariant VF Module UUID generated  on VF Module creation according to RFC 4122 <br>
     * It is generated  on service creation and stays  invariant even if service name /version are updated.
     */
    String getVfModuleModelInvariantUUID();

    /**
     * Resource Version . Ex. : "1"
     */
    String getVfModuleModelVersion();

    /**
     * Global UUID of the VF Module.<br>
     * It is generated by ASDC per each new VF module version. Generated UUID is compliant with RFC 4122. It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen ("-").<br>
     * Ex.: AA97B177-9383-4934-8543-0F91A7A02836
     */
    String getVfModuleModelUUID();


    /**
     * VF  Module textual description. Can be empty.
     */
    String getVfModuleModelDescription();


    /**
     * Is this VF module is the base module of the VF.
     */
    boolean isBase();

    /**
     * Array of VF Module deployment artifacts UUID.
     */
    List<String> getArtifacts();
}