org.whitesource.agent.api.model

Class DependencyInfo

java.lang.Object

org.whitesource.agent.api.model.DependencyInfo

All Implemented Interfaces:

java.io.Serializable

public class DependencyInfo
extends java.lang.Object
implements java.io.Serializable

WhiteSource Model for a project's dependency

Author:

tom.shapira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DependencyInfo() Default constructor
DependencyInfo(java.lang.String sha1) Constructor
DependencyInfo(java.lang.String sha1, java.lang.String fullHash) Constructor
DependencyInfo(java.lang.String groupId, java.lang.String artifactId, java.lang.String version) Constructor

Method Summary

Modifier and Type	Method and Description
void	addChecksum(ChecksumType checksumType, java.lang.String checksum)
void	addChild(DependencyInfo child)
boolean	equals(java.lang.Object o)
java.lang.String	getAdditionalSha1()
AnalysisInputs	getAnalysisInputs()
java.lang.String	getArchitecture()
java.lang.String	getArtifactId()
java.util.Map<ChecksumType,java.lang.String>	getChecksums()
java.util.Collection<DependencyInfo>	getChildren()
java.lang.String	getClassifier()
java.lang.String	getCommentlessSha1()
java.lang.String	getCommit()
java.lang.String	getDependencyFile()
DependencyType	getDependencyType()
java.lang.String	getFilename()
java.lang.String	getFullHash()
java.lang.String	getGroupId()
DependencyHintsInfo	getHints()
boolean	getIsModule()
java.lang.String	getLanguageVersion()
java.util.Date	getLastModified()
java.lang.String	getNoNewLinesSha1()
boolean	getOptional()
OSInfo	getOsInfo()
java.lang.String	getOtherPlatformSha1()
java.lang.String	getPurl()
java.lang.String	getRelease()
java.lang.String	getScope()
java.lang.String	getSha1()
java.lang.String	getSourcePackageName()
java.lang.String	getSystemPath()
java.lang.String	getType()
java.lang.String	getVersion()
VulnerabilityAnalysisResult	getVulnerabilityAnalysisResult()
boolean	hasChecksum()
boolean	hasChildren()
int	hashCode()
void	initAnalysisInputs() This method initializes the analysis inputs only if it's null.
void	initAnalysisInputs(java.lang.String euaArtifactId) This method initializes the analysisInputs only if it's null.
boolean	isDeduped()
boolean	isOptional()
void	resetUnusedFields() This method was created in WSE-5514 task which will help decrease the size of the update-request file, by removing all the empty initialized objects.
void	setAdditionalSha1(java.lang.String additionalSha1)
void	setAnalysisInputs(AnalysisInputs analysisInputs)
void	setArchitecture(java.lang.String architecture)
void	setArtifactId(java.lang.String artifactId)
void	setChecksums(java.util.Map<ChecksumType,java.lang.String> checksums)
void	setChildren(java.util.Collection<DependencyInfo> children)
void	setClassifier(java.lang.String classifier)
void	setCommentlessSha1(java.lang.String commentlessSha1)
void	setCommit(java.lang.String commit)
void	setDeduped(boolean deduped)
void	setDependencyFile(java.lang.String dependencyFile)
void	setDependencyType(DependencyType dependencyType)
void	setFilename(java.lang.String filename)
void	setFullHash(java.lang.String fullHash)
void	setGroupId(java.lang.String groupId)
void	setHints(DependencyHintsInfo hints)
void	setIsModule(boolean isModule)
void	setLanguageVersion(java.lang.String languageVersion)
void	setLastModified(java.util.Date lastModified)
void	setNoNewLinesSha1(java.lang.String noNewLinesSha1)
void	setOptional(boolean optional)
void	setOsInfo(OSInfo osInfo)
void	setOtherPlatformSha1(java.lang.String otherPlatformSha1)
void	setPurl(java.lang.String purl)
void	setRelease(java.lang.String release)
void	setScope(java.lang.String scope)
void	setSha1(java.lang.String sha1)
void	setSourcePackageName(java.lang.String sourcePackageName)
void	setSystemPath(java.lang.String systemPath)
void	setType(java.lang.String type)
void	setVersion(java.lang.String version)
void	setVulnerabilityAnalysisResult(VulnerabilityAnalysisResult vulnerabilityAnalysisResult)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DependencyInfo

public DependencyInfo()

Default constructor

DependencyInfo

public DependencyInfo(java.lang.String groupId,
                      java.lang.String artifactId,
                      java.lang.String version)

Constructor

Parameters:

groupId - - the dependency groupId

artifactId - - the dependency artifactId

version - - the dependency version

DependencyInfo

public DependencyInfo(java.lang.String sha1)

Constructor

Parameters:

sha1 - - the dependency sha1

DependencyInfo

public DependencyInfo(java.lang.String sha1,
                      java.lang.String fullHash)

Constructor

Parameters:

sha1 - - the dependency sha1

fullHash - - the dependency fullHash

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getGroupId

public java.lang.String getGroupId()

setGroupId

public void setGroupId(java.lang.String groupId)

getArtifactId

public java.lang.String getArtifactId()

setArtifactId

public void setArtifactId(java.lang.String artifactId)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getClassifier

public java.lang.String getClassifier()

setClassifier

public void setClassifier(java.lang.String classifier)

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String scope)

getSha1

public java.lang.String getSha1()

setSha1

public void setSha1(java.lang.String sha1)

getSystemPath

public java.lang.String getSystemPath()

getIsModule

public boolean getIsModule()

setIsModule

public void setIsModule(boolean isModule)

setSystemPath

public void setSystemPath(java.lang.String systemPath)

getOptional

public boolean getOptional()

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)

getChildren

public java.util.Collection<DependencyInfo> getChildren()

setChildren

public void setChildren(java.util.Collection<DependencyInfo> children)

addChild

public void addChild(DependencyInfo child)

hasChildren

public boolean hasChildren()

getLastModified

public java.util.Date getLastModified()

setLastModified

public void setLastModified(java.util.Date lastModified)

getCommentlessSha1

public java.lang.String getCommentlessSha1()

setCommentlessSha1

public void setCommentlessSha1(java.lang.String commentlessSha1)

getNoNewLinesSha1

public java.lang.String getNoNewLinesSha1()

setNoNewLinesSha1

public void setNoNewLinesSha1(java.lang.String noNewLinesSha1)

getOtherPlatformSha1

public java.lang.String getOtherPlatformSha1()

setOtherPlatformSha1

public void setOtherPlatformSha1(java.lang.String otherPlatformSha1)

getFullHash

public java.lang.String getFullHash()

setFullHash

public void setFullHash(java.lang.String fullHash)

getFilename

public java.lang.String getFilename()

setFilename

public void setFilename(java.lang.String filename)

getDependencyType

public DependencyType getDependencyType()

setDependencyType

public void setDependencyType(DependencyType dependencyType)

getHints

public DependencyHintsInfo getHints()

setHints

public void setHints(DependencyHintsInfo hints)

getChecksums

public java.util.Map<ChecksumType,java.lang.String> getChecksums()

setChecksums

public void setChecksums(java.util.Map<ChecksumType,java.lang.String> checksums)

addChecksum

public void addChecksum(ChecksumType checksumType,
                        java.lang.String checksum)

hasChecksum

public boolean hasChecksum()

getVulnerabilityAnalysisResult

public VulnerabilityAnalysisResult getVulnerabilityAnalysisResult()

setVulnerabilityAnalysisResult

public void setVulnerabilityAnalysisResult(VulnerabilityAnalysisResult vulnerabilityAnalysisResult)

getCommit

public java.lang.String getCommit()

setCommit

public void setCommit(java.lang.String commit)

getDependencyFile

public java.lang.String getDependencyFile()

setDependencyFile

public void setDependencyFile(java.lang.String dependencyFile)

getAdditionalSha1

public java.lang.String getAdditionalSha1()

setAdditionalSha1

public void setAdditionalSha1(java.lang.String additionalSha1)

getArchitecture

public java.lang.String getArchitecture()

setArchitecture

public void setArchitecture(java.lang.String architecture)

getLanguageVersion

public java.lang.String getLanguageVersion()

setLanguageVersion

public void setLanguageVersion(java.lang.String languageVersion)

isDeduped

public boolean isDeduped()

setDeduped

public void setDeduped(boolean deduped)

getOsInfo

public OSInfo getOsInfo()

setOsInfo

public void setOsInfo(OSInfo osInfo)

getAnalysisInputs

public AnalysisInputs getAnalysisInputs()

setAnalysisInputs

public void setAnalysisInputs(AnalysisInputs analysisInputs)

initAnalysisInputs

public void initAnalysisInputs()

This method initializes the analysis inputs only if it's null. Otherwise, nothing will happen. The artifactId is copied to the analysisInputs object.

initAnalysisInputs

public void initAnalysisInputs(java.lang.String euaArtifactId)

This method initializes the analysisInputs only if it's null. Otherwise, nothing will happen.

Parameters:

euaArtifactId - to be set inside the analysisInputs object

resetUnusedFields

public void resetUnusedFields()

This method was created in WSE-5514 task which will help decrease the size of the update-request file, by removing all the empty initialized objects. This method runs recursively on a dependencyInfo object and its children and reset all the initialized object which contains no elements (empty collections) In addition the analysisInputs object is set to null, as it is not needed in the update-request.

getSourcePackageName

public java.lang.String getSourcePackageName()

setSourcePackageName

public void setSourcePackageName(java.lang.String sourcePackageName)

getRelease

public java.lang.String getRelease()

setRelease

public void setRelease(java.lang.String release)

getPurl

public java.lang.String getPurl()

setPurl

public void setPurl(java.lang.String purl)