summaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-tosca-lib/src/main/java/org/openecomp/sdc/tosca/csar/Manifest.java
blob: d87850ac4b347deaad53c64177cb13856c5406e5 (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
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2019, Nordix Foundation. 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.tosca.csar;

import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;

public interface Manifest {

    /**
     * This Method will parse manifest, extracting fields mandatory/non-mandatory, if error occurred it's recorded and will be used for deciding if
     * manifest is valid
     *
     * @param is manifest file input stream
     */
    void parse(InputStream is);

    /**
     * Returns if manifest is valid
     *
     * @return true/false
     */
    boolean isValid();

    /**
     * Metadata section of manifest
     *
     * @return
     */
    Map<String, String> getMetadata();

    /**
     * Source section of manifest
     *
     * @return
     */
    List<String> getSources();

    /**
     * Validation errors of manifest
     *
     * @return
     */
    List<String> getErrors();

    /**
     * non mano section of manifest sol004 #4.3.7
     *
     * @return
     */
    Map<String, List<String>> getNonManoSources();

    /**
     * Gets the type based on the metadata of manifest file (VF/PNF)
     *
     * @return enum for type values
     */
    Optional<ResourceTypeEnum> getType();

    boolean isSigned();

    /**
     * Gets the CMS manifest signature if present in manifest
     *
     * @return the CMS manifest signature.
     */
    Optional<String> getCmsSignature();

    /**
     * Gets the Map of source path and it correspondent checksum.
     *
     * @return The source and checksum map.
     */
    Optional<Map<String, AlgorithmDigest>> getSourceAndChecksumMap();
}