org.whitesource.agent.api.dispatch

Class AsyncCheckPolicyComplianceRequest

java.lang.Object

org.whitesource.agent.api.dispatch.BaseRequest<AsyncCheckPolicyComplianceResult>

org.whitesource.agent.api.dispatch.AsyncCheckPolicyComplianceRequest

All Implemented Interfaces:

Serializable, ServiceRequest<AsyncCheckPolicyComplianceResult>

public class AsyncCheckPolicyComplianceRequest
extends BaseRequest<AsyncCheckPolicyComplianceResult>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	forceCheckAllDependencies When set to true, check that all dependencies sent to WhiteSource comply with organization policies.
protected boolean	populateVulnerabilities When set to true, get vulnerabilities for all dependencies without updating project.

Fields inherited from class org.whitesource.agent.api.dispatch.BaseRequest

agent, agentVersion, aggregateModules, aggregateProjectName, aggregateProjectToken, contributions, extraProperties, logData, orgToken, pluginVersion, preserveModuleStructure, product, productToken, productVersion, projects, requesterEmail, scanComment, scanSummaryInfo, timeStamp, type, userKey

Constructor Summary

Constructors

Constructor and Description
AsyncCheckPolicyComplianceRequest() Default constructor
AsyncCheckPolicyComplianceRequest(Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies) Constructor
AsyncCheckPolicyComplianceRequest(Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, boolean populateVulnerabilities) Constructor
AsyncCheckPolicyComplianceRequest(String orgToken, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies) Constructor
AsyncCheckPolicyComplianceRequest(String orgToken, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, boolean populateVulnerabilities) Constructor
AsyncCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, boolean populateVulnerabilities, String userKey, String requesterEmail, String logData, String productToken, ScanSummaryInfo scanSummaryInfo) Constructor
AsyncCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey, String requesterEmail, String logData, String productToken) Constructor
AsyncCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey, String requesterEmail, String logData, String productToken, ScanSummaryInfo scanSummaryInfo) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	isForceCheckAllDependencies()
boolean	isPopulateVulnerabilities()
void	setForceCheckAllDependencies(boolean forceCheckAllDependencies)
void	setPopulateVulnerabilities(boolean populateVulnerabilities)

Methods inherited from class org.whitesource.agent.api.dispatch.BaseRequest

agent, agentVersion, aggregateModules, aggregateProjectName, aggregateProjectToken, extraProperties, getContributions, getExtraProperties, getProjects, getScanSummaryInfo, logData, orgToken, pluginVersion, preserveModuleStructure, product, productToken, productVersion, requesterEmail, scanComment, setAgent, setAgentVersion, setAggregateModules, setAggregateProjectName, setAggregateProjectToken, setContributions, setExtraProperties, setLogData, setOrgToken, setPluginVersion, setPreserveModuleStructure, setProduct, setProductToken, setProductVersion, setProjects, setRequesterEmail, setScanComment, setScanSummaryInfo, setTimeStamp, setUserKey, timeStamp, type, userKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

forceCheckAllDependencies

protected 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.

populateVulnerabilities

protected boolean populateVulnerabilities

When set to true, get vulnerabilities for all dependencies without updating project. When set to false, will not get vulnerabilities for all dependencies.

Constructor Detail

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest()

Default constructor

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies)

Constructor

Parameters:

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Check policies for the all the Inventory or just for the new one.

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies,
                                         boolean populateVulnerabilities)

Constructor

Parameters:

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Check policies for the all the Inventory or just for the new one.

populateVulnerabilities - get vulnerabilities for each dependency without updating project

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(String orgToken,
                                         Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies,
                                         boolean populateVulnerabilities)

Constructor

Parameters:

orgToken - WhiteSource organization token.

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Check policies for the all the Inventory or just for the new one.

populateVulnerabilities - get vulnerabilities for each dependency without updating project

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(String orgToken,
                                         Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies)

Constructor

Parameters:

orgToken - WhiteSource organization token.

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Check policies for the all the Inventory or just for the new one.

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(String orgToken,
                                         String product,
                                         String productVersion,
                                         Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies,
                                         String userKey,
                                         String requesterEmail,
                                         String logData,
                                         String productToken)

Constructor

Parameters:

orgToken - Organization token uniquely identifying the account at white source.

product - The product name or token to update.

productVersion - The product version.

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Boolean to check new data only or not.

userKey - user key uniquely identifying the account at white source.

requesterEmail - Email of the WhiteSource user that requests to update WhiteSource.

logData - list of FSA's log data events

productToken - The product token

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(String orgToken,
                                         String product,
                                         String productVersion,
                                         Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies,
                                         String userKey,
                                         String requesterEmail,
                                         String logData,
                                         String productToken,
                                         ScanSummaryInfo scanSummaryInfo)

Constructor

Parameters:

orgToken - Organization token uniquely identifying the account at white source.

product - The product name or token to update.

productVersion - The product version.

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Boolean to check new data only or not.

userKey - user key uniquely identifying the account at white source.

requesterEmail - Email of the WhiteSource user that requests to update WhiteSource.

logData - list of FSA's log data events

productToken - The product token

scanSummaryInfo - Summary statistics for each step in Unified Agent

AsyncCheckPolicyComplianceRequest

public AsyncCheckPolicyComplianceRequest(String orgToken,
                                         String product,
                                         String productVersion,
                                         Collection<AgentProjectInfo> projects,
                                         boolean forceCheckAllDependencies,
                                         boolean populateVulnerabilities,
                                         String userKey,
                                         String requesterEmail,
                                         String logData,
                                         String productToken,
                                         ScanSummaryInfo scanSummaryInfo)

Constructor

Parameters:

orgToken - Organization token uniquely identifying the account at white source.

product - The product name or token to update.

productVersion - The product version.

projects - Open Source usage statement to check against policies.

forceCheckAllDependencies - Boolean to check new data only or not.

userKey - user key uniquely identifying the account at white source.

requesterEmail - Email of the WhiteSource user that requests to update WhiteSource.

logData - list of FSA's log data events

productToken - The product token

scanSummaryInfo - Summary statistics for each step in Unified Agent

populateVulnerabilities - get vulnerabilities for each dependency without updating project

Method Detail

isForceCheckAllDependencies

public boolean isForceCheckAllDependencies()

setForceCheckAllDependencies

public void setForceCheckAllDependencies(boolean forceCheckAllDependencies)

isPopulateVulnerabilities

public boolean isPopulateVulnerabilities()

setPopulateVulnerabilities

public void setPopulateVulnerabilities(boolean populateVulnerabilities)