org.whitesource.agent.api.dispatch

Class CheckPolicyComplianceRequest

java.lang.Object

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

org.whitesource.agent.api.dispatch.CheckPolicyComplianceRequest

All Implemented Interfaces:

Serializable, ServiceRequest<CheckPolicyComplianceResult>

public class CheckPolicyComplianceRequest
extends BaseRequest<CheckPolicyComplianceResult>

Request to check policies application results before actual inventory update inventory. The decision if check the policies for all the inventory or just the new data is made by the user.

Created by anna.rozin

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.

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

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

Constructor Summary

Constructors

Constructor and Description
CheckPolicyComplianceRequest() Default constructor
CheckPolicyComplianceRequest(Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies) Constructor
CheckPolicyComplianceRequest(String orgToken, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies) Constructor
CheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey, String requesterEmail, String logData, String productToken) Constructor
CheckPolicyComplianceRequest(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()
void	setForceCheckAllDependencies(boolean forceCheckAllDependencies)

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

agent, agentVersion, aggregateModules, aggregateProjectName, aggregateProjectToken, extraProperties, getExtraProperties, getProjects, getScanSummaryInfo, logData, orgToken, pluginVersion, preserveModuleStructure, product, productToken, productVersion, requesterEmail, scanComment, setAgent, setAgentVersion, setAggregateModules, setAggregateProjectName, setAggregateProjectToken, 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.

Constructor Detail

CheckPolicyComplianceRequest

public CheckPolicyComplianceRequest()

Default constructor

CheckPolicyComplianceRequest

public CheckPolicyComplianceRequest(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.

CheckPolicyComplianceRequest

public CheckPolicyComplianceRequest(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.

CheckPolicyComplianceRequest

public CheckPolicyComplianceRequest(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

CheckPolicyComplianceRequest

public CheckPolicyComplianceRequest(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

Method Detail

isForceCheckAllDependencies

public boolean isForceCheckAllDependencies()

setForceCheckAllDependencies

public void setForceCheckAllDependencies(boolean forceCheckAllDependencies)