org.owasp.dependencycheck.xml.pom.Model Maven / Gradle / Ivy
/*
* This file is part of dependency-check-core.
*
* 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.
*
* Copyright (c) 2015 Jeremy Long. All Rights Reserved.
*/
package org.owasp.dependencycheck.xml.pom;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import javax.annotation.concurrent.ThreadSafe;
import org.owasp.dependencycheck.utils.InterpolationUtil;
/**
* A simple pojo to hold data related to a Maven POM file.
*
* @author jeremy long
*/
@ThreadSafe
public class Model implements Serializable {
/**
* Generated UUID.
*/
private static final long serialVersionUID = -7648711671774349441L;
/**
* The name of the project.
*/
private String name;
/**
* The organization name.
*/
private String organization;
/**
* The organization URL.
*/
private String organizationUrl;
/**
* The description.
*/
private String description;
/**
* The group id.
*/
private String groupId;
/**
* The artifact id.
*/
private String artifactId;
/**
* The version number.
*/
private String version;
/**
* The parent group id.
*/
private String parentGroupId;
/**
* The parent artifact id.
*/
private String parentArtifactId;
/**
* The parent version number.
*/
private String parentVersion;
/**
* The list of licenses.
*/
private final List licenses = new ArrayList<>();
/**
* The list of developers.
*/
private final List developers = new ArrayList<>();
/**
* The project URL.
*/
private String projectURL;
/**
* Get the value of name.
*
* @return the value of name
*/
public String getName() {
return name;
}
/**
* Set the value of name.
*
* @param name new value of name
*/
public void setName(String name) {
this.name = name;
}
/**
* Get the value of organization.
*
* @return the value of organization
*/
public String getOrganization() {
return organization;
}
/**
* Set the value of organization.
*
* @param organization new value of organization
*/
public void setOrganization(String organization) {
this.organization = organization;
}
/**
* Get the value of organizationUrl.
*
* @return the value of organizationUrl
*/
public String getOrganizationUrl() {
return organizationUrl;
}
/**
* Set the value of organizationUrl.
*
* @param organizationUrl new value of organizationUrl
*/
public void setOrganizationUrl(String organizationUrl) {
this.organizationUrl = organizationUrl;
}
/**
* Get the value of description.
*
* @return the value of description
*/
public String getDescription() {
return description;
}
/**
* Set the value of description.
*
* @param description new value of description
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Get the value of groupId.
*
* @return the value of groupId
*/
public String getGroupId() {
return groupId;
}
/**
* Set the value of groupId.
*
* @param groupId new value of groupId
*/
public void setGroupId(String groupId) {
this.groupId = groupId;
}
/**
* Get the value of artifactId.
*
* @return the value of artifactId
*/
public String getArtifactId() {
return artifactId;
}
/**
* Set the value of artifactId.
*
* @param artifactId new value of artifactId
*/
public void setArtifactId(String artifactId) {
this.artifactId = artifactId;
}
/**
* Get the value of version.
*
* @return the value of version
*/
public String getVersion() {
return version;
}
/**
* Set the value of version.
*
* @param version new value of version
*/
public void setVersion(String version) {
this.version = version;
}
/**
* Get the value of parentGroupId.
*
* @return the value of parentGroupId
*/
public String getParentGroupId() {
return parentGroupId;
}
/**
* Set the value of parentGroupId.
*
* @param parentGroupId new value of parentGroupId
*/
public void setParentGroupId(String parentGroupId) {
this.parentGroupId = parentGroupId;
}
/**
* Get the value of parentArtifactId.
*
* @return the value of parentArtifactId
*/
public String getParentArtifactId() {
return parentArtifactId;
}
/**
* Set the value of parentArtifactId.
*
* @param parentArtifactId new value of parentArtifactId
*/
public void setParentArtifactId(String parentArtifactId) {
this.parentArtifactId = parentArtifactId;
}
/**
* Get the value of parentVersion.
*
* @return the value of parentVersion
*/
public String getParentVersion() {
return parentVersion;
}
/**
* Set the value of parentVersion.
*
* @param parentVersion new value of parentVersion
*/
public void setParentVersion(String parentVersion) {
this.parentVersion = parentVersion;
}
/**
* Returns the list of licenses.
*
* @return the list of licenses
*/
public List getLicenses() {
return licenses;
}
/**
* Adds a new license to the list of licenses.
*
* @param license the license to add
*/
public void addLicense(License license) {
licenses.add(license);
}
/**
* Returns the list of developers.
*
* @return the list of developers
*/
public List getDevelopers() {
return developers;
}
/**
* Adds a new developer to the list of developers.
*
* @param developer the developer to add
*/
public void addDeveloper(Developer developer) {
developers.add(developer);
}
/**
* Get the value of projectURL.
*
* @return the value of projectURL
*/
public String getProjectURL() {
return projectURL;
}
/**
* Set the value of projectURL.
*
* @param projectURL new value of projectURL
*/
public void setProjectURL(String projectURL) {
this.projectURL = projectURL;
}
/**
* Process the Maven properties file and interpolate all properties.
*
* @param properties new value of properties
*/
public void processProperties(Properties properties) {
if (properties == null) {
return;
}
this.description = InterpolationUtil.interpolate(this.description, properties);
for (License l : this.getLicenses()) {
l.setName(InterpolationUtil.interpolate(l.getName(), properties));
l.setUrl(InterpolationUtil.interpolate(l.getUrl(), properties));
}
this.name = InterpolationUtil.interpolate(this.name, properties);
this.projectURL = InterpolationUtil.interpolate(this.projectURL, properties);
this.organization = InterpolationUtil.interpolate(this.organization, properties);
this.parentGroupId = InterpolationUtil.interpolate(this.parentGroupId, properties);
this.parentArtifactId = InterpolationUtil.interpolate(this.parentArtifactId, properties);
this.parentVersion = InterpolationUtil.interpolate(this.parentVersion, properties);
}
/**
* Replaces the group/artifact/version obtained from the `pom.xml` which may
* contain variable references with the interpolated values of the
*