-
-
Notifications
You must be signed in to change notification settings - Fork 83
/
ModelConverter.java
66 lines (57 loc) · 2.6 KB
/
ModelConverter.java
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
/*
* This file is part of CycloneDX Maven Plugin.
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* Copyright (c) OWASP Foundation. All Rights Reserved.
*/
package org.cyclonedx.maven;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.project.MavenProject;
import org.cyclonedx.CycloneDxSchema;
import org.cyclonedx.model.Component;
import org.cyclonedx.model.ExternalReference;
import org.cyclonedx.model.Metadata;
/**
* Model converter from Maven concepts (dependency Artifact + MavenProject) to CycloneDX ones
* (resp. Component with pURL + Metadata).
*/
public interface ModelConverter {
String generatePackageUrl(Artifact artifact);
String generateVersionlessPackageUrl(final Artifact artifact);
String generatePackageUrl(final org.eclipse.aether.artifact.Artifact artifact);
String generateVersionlessPackageUrl(final org.eclipse.aether.artifact.Artifact artifact);
String generateClassifierlessPackageUrl(final org.eclipse.aether.artifact.Artifact artifact);
/**
* Converts a Maven artifact (dependency or transitive dependency) into a
* CycloneDX component.
*
* @param artifact the artifact to convert
* @param schemaVersion the target CycloneDX schema version
* @param includeLicenseText should license text be included in bom?
* @return a CycloneDX component
*/
Component convertMavenDependency(Artifact artifact, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText);
/**
* Converts a MavenProject into a CycloneDX Metadata object.
*
* @param project the MavenProject to convert
* @param projectType the target CycloneDX component type
* @param schemaVersion the target CycloneDX schema version
* @param includeLicenseText should license text be included in bom?
* @param externalReferences the external references
* @return a CycloneDX Metadata object
*/
Metadata convertMavenProject(MavenProject project, String projectType, CycloneDxSchema.Version schemaVersion, boolean includeLicenseText, ExternalReference[] externalReferences);
}