org.whitesource.agent.api.dispatch

Class UpdateInventoryRequest

java.lang.Object

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

org.whitesource.agent.api.dispatch.UpdateInventoryRequest

All Implemented Interfaces:

Serializable, ServiceRequest<UpdateInventoryResult>

public class UpdateInventoryRequest
extends BaseRequest<UpdateInventoryResult>

Request to update organization inventory.

Author:

tom.shapira

See Also:

Serialized Form

Field Summary

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
UpdateInventoryRequest() Default constructor
UpdateInventoryRequest(Collection<AgentProjectInfo> projects) Constructor
UpdateInventoryRequest(Collection<AgentProjectInfo> projects, UpdateType updateType) Constructor
UpdateInventoryRequest(String orgToken, Collection<AgentProjectInfo> projects) Constructor
UpdateInventoryRequest(String orgToken, Collection<AgentProjectInfo> projects, UpdateType updateType) Constructor
UpdateInventoryRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String scanComment) Constructor to create offline request
UpdateInventoryRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String scanComment, ScanSummaryInfo scanSummaryInfo) Constructor to create offline request
UpdateInventoryRequest(String orgToken, String requesterEmail, UpdateType updateType, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String logData, String scanComment, String productToken) Constructor
UpdateInventoryRequest(String orgToken, String requesterEmail, UpdateType updateType, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String logData, String scanComment, String productToken, ScanSummaryInfo scanSummaryInfo) Constructor

Method Summary

Modifier and Type	Method and Description
UpdateType	getUpdateType()
void	setUpdateType(UpdateType updateType)

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

Constructor Detail

UpdateInventoryRequest

public UpdateInventoryRequest()

Default constructor

UpdateInventoryRequest

public UpdateInventoryRequest(Collection<AgentProjectInfo> projects)

Constructor

Parameters:

projects - Open Source usage statement to update White Source.

UpdateInventoryRequest

public UpdateInventoryRequest(Collection<AgentProjectInfo> projects,
                              UpdateType updateType)

Constructor

Parameters:

projects - Open Source usage statement to update White Source.

updateType - Request UpdateType

UpdateInventoryRequest

public UpdateInventoryRequest(String orgToken,
                              Collection<AgentProjectInfo> projects)

Constructor

Parameters:

orgToken - WhiteSource organization token.

projects - Open Source usage statement to update White Source.

UpdateInventoryRequest

public UpdateInventoryRequest(String orgToken,
                              Collection<AgentProjectInfo> projects,
                              UpdateType updateType)

Constructor

Parameters:

orgToken - WhiteSource organization token.

projects - Open Source usage statement to update White Source.

updateType - Request UpdateType

UpdateInventoryRequest

public UpdateInventoryRequest(String orgToken,
                              String requesterEmail,
                              UpdateType updateType,
                              String product,
                              String productVersion,
                              Collection<AgentProjectInfo> projects,
                              String userKey,
                              String logData,
                              String scanComment,
                              String productToken)

Constructor

Parameters:

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

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

updateType - Request UpdateType

product - The product name or token to update.

productVersion - The product version.

productToken - The product token.

projects - OSS usage information to send to white source.

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

logData - list of FSA's log data events

scanComment - scan description

UpdateInventoryRequest

public UpdateInventoryRequest(String orgToken,
                              String requesterEmail,
                              UpdateType updateType,
                              String product,
                              String productVersion,
                              Collection<AgentProjectInfo> projects,
                              String userKey,
                              String logData,
                              String scanComment,
                              String productToken,
                              ScanSummaryInfo scanSummaryInfo)

Constructor

Parameters:

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

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

updateType - Request UpdateType

product - The product name or token to update.

productVersion - The product version.

productToken - The product token.

projects - OSS usage information to send to white source.

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

logData - list of FSA's log data events

scanComment - scan description

scanSummaryInfo - Summary statistics for each step in Unified Agent

UpdateInventoryRequest

public UpdateInventoryRequest(String orgToken,
                              String product,
                              String productVersion,
                              Collection<AgentProjectInfo> projects,
                              String userKey,
                              String scanComment)

Constructor to create offline request

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projects - OSS usage information to send to white source.

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

scanComment - scan description

UpdateInventoryRequest

public UpdateInventoryRequest(String orgToken,
                              String product,
                              String productVersion,
                              Collection<AgentProjectInfo> projects,
                              String userKey,
                              String scanComment,
                              ScanSummaryInfo scanSummaryInfo)

Constructor to create offline request

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projects - OSS usage information to send to white source.

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

scanComment - scan description

scanSummaryInfo - Summary statistics for each step in Unified Agent

Method Detail

getUpdateType

public UpdateType getUpdateType()

Returns:

Request UpdateType

setUpdateType

public void setUpdateType(UpdateType updateType)

Parameters:

updateType - Request UpdateType