Serialized Form (API bindings 2.9.9.36 API)

Package org.whitesource.agent.api.dispatch
- Class org.whitesource.agent.api.dispatch.BaseCheckPoliciesResult extends BaseResult implements Serializable
  
  serialVersionUID:
  
  -4268012175086999291L
  - Serialized Fields
    - existingProjects
```
Map<K,V> existingProjects
```
      Map of project name to the root of its dependency graph with policies application result.
    - newProjects
```
Map<K,V> newProjects
```
      Map of project name to the root of its dependency graph with policies application result.
    - projectNewResources
```
Map<K,V> projectNewResources
```
      Map of project name to its set of new resources to insert into inventory.
- Class org.whitesource.agent.api.dispatch.BaseRequest extends Object implements Serializable
  
  serialVersionUID:
  
  4691829529579651426L
  - Serialized Fields
    - type
```
RequestType type
```
    - agent
```
String agent
```
    - agentVersion
```
String agentVersion
```
    - pluginVersion
```
String pluginVersion
```
    - orgToken
```
String orgToken
```
    - userKey
```
String userKey
```
    - product
```
String product
```
    - productVersion
```
String productVersion
```
    - timeStamp
```
long timeStamp
```
    - requesterEmail
```
String requesterEmail
```
    - projects
```
Collection<E> projects
```
    - aggregateModules
```
boolean aggregateModules
```
    - preserveModuleStructure
```
boolean preserveModuleStructure
```
    - aggregateProjectName
```
String aggregateProjectName
```
    - aggregateProjectToken
```
String aggregateProjectToken
```
    - logData
```
String logData
```
    - scanComment
```
String scanComment
```
    - productToken
```
String productToken
```
    - extraProperties
```
Map<K,V> extraProperties
```
    - scanSummaryInfo
```
ScanSummaryInfo scanSummaryInfo
```
- Class org.whitesource.agent.api.dispatch.BaseResult extends Object implements Serializable
  
  serialVersionUID:
  
  6143216164199328453L
  - Serialized Fields
    - organization
```
String organization
```
      Name of organization in.
    - requestToken
```
String requestToken
```
- Class org.whitesource.agent.api.dispatch.CheckPoliciesRequest extends BaseRequest<CheckPoliciesResult> implements Serializable
  
  serialVersionUID:
  
  -6894332358170182935L
- Class org.whitesource.agent.api.dispatch.CheckPoliciesResult extends BaseCheckPoliciesResult implements Serializable
  
  serialVersionUID:
  
  7083481460957821913L
- Class org.whitesource.agent.api.dispatch.CheckPolicyComplianceRequest extends BaseRequest<CheckPolicyComplianceResult> implements Serializable
  
  serialVersionUID:
  
  -8257797945728036283L
  - Serialized Fields
    - forceCheckAllDependencies
```
boolean forceCheckAllDependencies
```
      When set to true, check that all dependencies sent to WhiteSource comply with organization policies. When set to false, check that the added dependencies sent to WhiteSource comply with organization policies.
- Class org.whitesource.agent.api.dispatch.CheckPolicyComplianceResult extends BaseCheckPoliciesResult implements Serializable
  
  serialVersionUID:
  
  -3031495415514845777L
- Class org.whitesource.agent.api.dispatch.CheckVulnerabilitiesRequest extends BaseRequest<CheckVulnerabilitiesResult> implements Serializable
  
  serialVersionUID:
  
  -945532206429866395L
- Class org.whitesource.agent.api.dispatch.CheckVulnerabilitiesResult extends Object implements Serializable
  
  serialVersionUID:
  
  -6580191828869055056L
  - Serialized Fields
    - sha1ToVulnerabilitiesMap
```
Map<K,V> sha1ToVulnerabilitiesMap
```
- Class org.whitesource.agent.api.dispatch.ConfigurationRequest extends BaseRequest<ConfigurationResult> implements Serializable
  
  serialVersionUID:
  
  1565062936737064054L
- Class org.whitesource.agent.api.dispatch.ConfigurationResult extends BaseResult implements Serializable
  
  serialVersionUID:
  
  4057058239018411900L
  - Serialized Fields
    - id
```
String id
```
    - checkPolicies
```
boolean checkPolicies
```
    - forceCheckAllDependencies
```
boolean forceCheckAllDependencies
```
    - forceUpdate
```
boolean forceUpdate
```
    - projectPerFolder
```
boolean projectPerFolder
```
    - updateType
```
UpdateType updateType
```
    - requesterEmail
```
String requesterEmail
```
    - caseSensitiveGlob
```
boolean caseSensitiveGlob
```
    - followSymbolicLinks
```
boolean followSymbolicLinks
```
    - scanPackageManager
```
boolean scanPackageManager
```
    - includes
```
String includes
```
    - excludes
```
String excludes
```
    - fsaConfiguration
```
FsaConfiguration fsaConfiguration
```
- Class org.whitesource.agent.api.dispatch.FsaConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  -4407661669260351123L
  - Serialized Fields
    - npmIgnoreJavaScriptFiles
```
boolean npmIgnoreJavaScriptFiles
```
    - npmResolveDependencies
```
boolean npmResolveDependencies
```
    - npmIncludeDevDependencies
```
boolean npmIncludeDevDependencies
```
    - npmRunPreStep
```
boolean npmRunPreStep
```
    - npmIgnoreNpmLsErrors
```
boolean npmIgnoreNpmLsErrors
```
    - bowerResolveDependencies
```
boolean bowerResolveDependencies
```
    - bowerRunPreStep
```
boolean bowerRunPreStep
```
    - pythonResolveDependencies
```
boolean pythonResolveDependencies
```
    - mavenIgnoredScopes
```
String mavenIgnoredScopes
```
    - mavenResolveDependencies
```
boolean mavenResolveDependencies
```
    - mavenAggregateModules
```
boolean mavenAggregateModules
```
    - gradleResolveDependencies
```
boolean gradleResolveDependencies
```
    - gradleRunAssembleCommand
```
boolean gradleRunAssembleCommand
```
    - dockerIncludes
```
String dockerIncludes
```
    - dockerExcludes
```
String dockerExcludes
```
    - scanDockerImages
```
boolean scanDockerImages
```
    - scmType
```
String scmType
```
    - scmUser
```
String scmUser
```
    - scmPass
```
String scmPass
```
    - scmPPK
```
String scmPPK
```
    - scmUrl
```
String scmUrl
```
    - scmBranch
```
String scmBranch
```
- Class org.whitesource.agent.api.dispatch.GetDependencyDataRequest extends BaseRequest<GetDependencyDataResult> implements Serializable
  
  serialVersionUID:
  
  -2644123740414663681L
- Class org.whitesource.agent.api.dispatch.GetDependencyDataResult extends Object implements Serializable
  
  serialVersionUID:
  
  -6064404450850954766L
  - Serialized Fields
    - organization
```
String organization
```
      Name of organization in.
    - resources
```
Collection<E> resources
```
      Resources Info Collection.
- Class org.whitesource.agent.api.dispatch.ResultEnvelope extends Object implements Serializable
  
  serialVersionUID:
  
  -3835912575385728376L
  - Serialized Fields
    - envelopeVersion
```
String envelopeVersion
```
    - status
```
int status
```
      Status code of the operation.
    - message
```
String message
```
      Human readable message.
    - data
```
String data
```
      Data associated with the result
    - requestToken
```
String requestToken
```
      Identifier of the request for support purposes
- Class org.whitesource.agent.api.dispatch.SummaryScanRequest extends BaseRequest<SummaryScanResult> implements Serializable
  
  serialVersionUID:
  
  -276101415154446987L
- Class org.whitesource.agent.api.dispatch.SummaryScanResult extends BaseResult implements Serializable
  
  serialVersionUID:
  
  5277673506168727608L
  - Serialized Fields
    - updatedProjects
```
Collection<E> updatedProjects
```
    - createdProjects
```
Collection<E> createdProjects
```
- Class org.whitesource.agent.api.dispatch.UpdateInventoryRequest extends BaseRequest<UpdateInventoryResult> implements Serializable
  
  serialVersionUID:
  
  7731258010033962980L
  - Serialized Fields
    - updateType
```
UpdateType updateType
```
- Class org.whitesource.agent.api.dispatch.UpdateInventoryResult extends BaseResult implements Serializable
  
  serialVersionUID:
  
  9074828488465436483L
  - Serialized Fields
    - removeIfExist
```
boolean removeIfExist
```
    - updatedProjects
```
Collection<E> updatedProjects
```
    - createdProjects
```
Collection<E> createdProjects
```
    - projectNamesToIds
```
HashMap<K,V> projectNamesToIds
```
    - projectNamesToDetails
```
HashMap<K,V> projectNamesToDetails
```
Package org.whitesource.agent.api.model
- Class org.whitesource.agent.api.model.AgentProjectInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -7847114716505720514L
  - Serialized Fields
    - coordinates
```
Coordinates coordinates
```
    - parentCoordinates
```
Coordinates parentCoordinates
```
    - dependencies
```
Collection<E> dependencies
```
    - projectToken
```
String projectToken
```
    - projectSetupStatus
```
ProjectSetupStatus projectSetupStatus
```
    - projectSetupDescription
```
String projectSetupDescription
```
    - projectTags
```
Collection<E> projectTags
```
    - viaLanguageName
```
String viaLanguageName
```
- Class org.whitesource.agent.api.model.Coordinates extends Object implements Serializable
  
  serialVersionUID:
  
  4962222806117752812L
  - Serialized Fields
    - groupId
```
String groupId
```
    - artifactId
```
String artifactId
```
    - version
```
String version
```
- Class org.whitesource.agent.api.model.CopyrightInfo extends Object implements Serializable
  
  serialVersionUID:
  
  7366184386342223073L
  - Serialized Fields
    - copyright
```
String copyright
```
    - line
```
int line
```
- Class org.whitesource.agent.api.model.DependencyHintsInfo extends Object implements Serializable
  
  serialVersionUID:
  
  776719618926129849L
  - Serialized Fields
    - companyName
```
String companyName
```
    - fileVersion
```
String fileVersion
```
    - copyright
```
String copyright
```
    - originalFilename
```
String originalFilename
```
    - productName
```
String productName
```
    - productVersion
```
String productVersion
```
    - issuerCommonName
```
String issuerCommonName
```
    - subjectCommonName
```
String subjectCommonName
```
- Class org.whitesource.agent.api.model.DependencyInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -6212622409560068635L
  - Serialized Fields
    - groupId
```
String groupId
```
    - artifactId
```
String artifactId
```
    - version
```
String version
```
    - type
```
String type
```
    - classifier
```
String classifier
```
    - scope
```
String scope
```
    - sha1
```
String sha1
```
    - headerSha1
```
String headerSha1
```
    - footerSha1
```
String footerSha1
```
    - utf8Sha1
```
String utf8Sha1
```
    - fullHash
```
String fullHash
```
    - mostSigBitsHash
```
String mostSigBitsHash
```
    - leastSigBitsHash
```
String leastSigBitsHash
```
    - commentlessSha1
```
String commentlessSha1
```
    - noNewLinesSha1
```
String noNewLinesSha1
```
    - otherPlatformSha1
```
String otherPlatformSha1
```
    - systemPath
```
String systemPath
```
    - optional
```
boolean optional
```
    - children
```
Collection<E> children
```
    - exclusions
```
Collection<E> exclusions
```
    - licenses
```
Collection<E> licenses
```
    - copyrights
```
Collection<E> copyrights
```
    - lastModified
```
Date lastModified
```
    - filename
```
String filename
```
    - dependencyType
```
DependencyType dependencyType
```
    - hints
```
DependencyHintsInfo hints
```
    - checksums
```
Map<K,V> checksums
```
    - vulnerabilityAnalysisResult
```
VulnerabilityAnalysisResult vulnerabilityAnalysisResult
```
    - commit
```
String commit
```
    - dependencyFile
```
String dependencyFile
```
    - additionalSha1
```
String additionalSha1
```
    - architecture
```
String architecture
```
    - languageVersion
```
String languageVersion
```
    - deduped
```
boolean deduped
```
    - dependencyModulesToPaths
```
Map<K,V> dependencyModulesToPaths
```
    - euaArtifactId
```
String euaArtifactId
```
- Class org.whitesource.agent.api.model.ExclusionInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -3900555692407177279L
  - Serialized Fields
    - artifactId
```
String artifactId
```
    - groupId
```
String groupId
```
- Class org.whitesource.agent.api.model.FilesMathchingStepInfo extends StepInfo implements Serializable
  - Serialized Fields
    - totalSourceBinariesFound
```
int totalSourceBinariesFound
```
- Class org.whitesource.agent.api.model.PolicyCheckResourceNode extends Object implements Serializable
  
  serialVersionUID:
  
  -3206810244665473L
  - Serialized Fields
    - resource
```
ResourceInfo resource
```
    - policy
```
RequestPolicyInfo policy
```
    - children
```
Collection<E> children
```
- Class org.whitesource.agent.api.model.ProjectDetails extends Object implements Serializable
  
  serialVersionUID:
  
  6155870504657108377L
  - Serialized Fields
    - projectName
```
String projectName
```
    - projectId
```
Integer projectId
```
    - projectToken
```
String projectToken
```
- Class org.whitesource.agent.api.model.ProjectTag extends Object implements Serializable
  
  serialVersionUID:
  
  1835100904098326933L
  - Serialized Fields
    - tagKey
```
String tagKey
```
    - tagValue
```
String tagValue
```
- Class org.whitesource.agent.api.model.RequestPolicyInfo extends Object implements Serializable
  
  serialVersionUID:
  
  6475167885231211089L
  - Serialized Fields
    - displayName
```
String displayName
```
    - filterType
```
String filterType
```
    - filterLogic
```
String filterLogic
```
    - actionType
```
String actionType
```
    - actionLogic
```
String actionLogic
```
    - projectLevel
```
boolean projectLevel
```
    - inclusive
```
boolean inclusive
```
    - policyLevel
```
String policyLevel
```
- Class org.whitesource.agent.api.model.ResolverStepInfo extends StepInfo implements Serializable
  - Serialized Fields
    - totalUniqueDependenciesFound
```
int totalUniqueDependenciesFound
```
    - totalDuplicateDependenciesFound
```
int totalDuplicateDependenciesFound
```
- Class org.whitesource.agent.api.model.ResourceInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1707994312298243732L
  - Serialized Fields
    - displayName
```
String displayName
```
    - link
```
String link
```
    - licenses
```
Collection<E> licenses
```
    - sha1
```
String sha1
```
      Since:
      
      2.2.8
    - vulnerabilities
```
Collection<E> vulnerabilities
```
    - homepageUrl
```
String homepageUrl
```
    - description
```
String description
```
    - keyUuid
```
String keyUuid
```
      Since:
      
      2.9.8
- Class org.whitesource.agent.api.model.ScanSummaryInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -3801913583253812987L
  - Serialized Fields
    - totalElapsedTime
```
long totalElapsedTime
```
    - stepsSummaryInfo
```
Collection<E> stepsSummaryInfo
```
- Class org.whitesource.agent.api.model.StepInfo extends Object implements Serializable
  
  serialVersionUID:
  
  7972930644057281908L
  - Serialized Fields
    - stepName
```
String stepName
```
    - totalElapsedTime
```
long totalElapsedTime
```
    - isSubStep
```
boolean isSubStep
```
    - stepCompletionStatus
```
StepCompletionStatus stepCompletionStatus
```
    - subStepsInfo
```
Collection<E> subStepsInfo
```
- Class org.whitesource.agent.api.model.VulnerabilityInfo extends Object implements Serializable
  
  serialVersionUID:
  
  86315184735909079L
  - Serialized Fields
    - name
```
String name
```
    - severity
```
String severity
```
    - score
```
float score
```
    - elements
```
Collection<E> elements
```
    - vulnerableEntities
```
Collection<E> vulnerableEntities
```
- Class org.whitesource.agent.api.model.VulnerableEntity extends Object implements Serializable
  
  serialVersionUID:
  
  6521642112001095631L
  - Serialized Fields
    - element
```
String element
```
    - startLine
```
int startLine
```
    - endLine
```
int endLine
```

Serialized Form

Package org.whitesource.agent.api.dispatch

Class org.whitesource.agent.api.dispatch.BaseCheckPoliciesResult extends BaseResult implements Serializable

Serialized Fields

existingProjects

newProjects

projectNewResources

Class org.whitesource.agent.api.dispatch.BaseRequest extends Object implements Serializable

Serialized Fields

type

agent

agentVersion

pluginVersion

orgToken

userKey

product

productVersion

timeStamp

requesterEmail

projects

aggregateModules

preserveModuleStructure

aggregateProjectName

aggregateProjectToken

logData

scanComment

productToken

extraProperties

scanSummaryInfo

Class org.whitesource.agent.api.dispatch.BaseResult extends Object implements Serializable

Serialized Fields

organization

requestToken

Class org.whitesource.agent.api.dispatch.CheckPoliciesRequest extends BaseRequest<CheckPoliciesResult> implements Serializable

Class org.whitesource.agent.api.dispatch.CheckPoliciesResult extends BaseCheckPoliciesResult implements Serializable

Class org.whitesource.agent.api.dispatch.CheckPolicyComplianceRequest extends BaseRequest<CheckPolicyComplianceResult> implements Serializable

Serialized Fields

forceCheckAllDependencies

Class org.whitesource.agent.api.dispatch.CheckPolicyComplianceResult extends BaseCheckPoliciesResult implements Serializable

Class org.whitesource.agent.api.dispatch.CheckVulnerabilitiesRequest extends BaseRequest<CheckVulnerabilitiesResult> implements Serializable

Class org.whitesource.agent.api.dispatch.CheckVulnerabilitiesResult extends Object implements Serializable

Serialized Fields

sha1ToVulnerabilitiesMap

Class org.whitesource.agent.api.dispatch.ConfigurationRequest extends BaseRequest<ConfigurationResult> implements Serializable

Class org.whitesource.agent.api.dispatch.ConfigurationResult extends BaseResult implements Serializable

Serialized Fields

id

checkPolicies

forceCheckAllDependencies

forceUpdate

projectPerFolder

updateType

requesterEmail

caseSensitiveGlob

followSymbolicLinks

scanPackageManager

includes

excludes

fsaConfiguration

Class org.whitesource.agent.api.dispatch.FsaConfiguration extends Object implements Serializable

Serialized Fields

npmIgnoreJavaScriptFiles

npmResolveDependencies

npmIncludeDevDependencies

npmRunPreStep

npmIgnoreNpmLsErrors

bowerResolveDependencies

bowerRunPreStep

pythonResolveDependencies

mavenIgnoredScopes

mavenResolveDependencies

mavenAggregateModules

gradleResolveDependencies

gradleRunAssembleCommand

dockerIncludes

dockerExcludes

scanDockerImages

scmType

scmUser

scmPass