org.whitesource.agent.api.dispatch

Class RequestFactory

java.lang.Object

org.whitesource.agent.api.dispatch.RequestFactory

public class RequestFactory
extends Object

Factory for constructing ServiceRequest.

Author:

Edo.Shor

Constructor Summary

Constructors

Constructor and Description
RequestFactory(String agent, String agentVersion, String pluginVersion) Constructor

Method Summary

Modifier and Type	Method and Description
CheckPoliciesRequest	newCheckPoliciesRequest(String orgToken, Collection<AgentProjectInfo> projects, String userKey) Create new Check policies request.
CheckPoliciesRequest	newCheckPoliciesRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey)
CheckPoliciesRequest	newCheckPoliciesRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String requesterEmail) Deprecated. Use newCheckPolicyComplianceRequest(String, String, String, Collection, boolean, String)
CheckPolicyComplianceRequest	newCheckPolicyComplianceRequest(String orgToken, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey) Create new Check policies request.
CheckPolicyComplianceRequest	newCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey)
CheckPolicyComplianceRequest	newCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey, String requesterEmail) Create new Check policies request.
CheckPolicyComplianceRequest	newCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey, String requesterEmail, boolean aggregateModules, boolean preserveModuleStructure, String aggregateProjectName, String aggregateProjectToken) Create new Check policies request.
CheckPolicyComplianceRequest	newCheckPolicyComplianceRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, boolean forceCheckAllDependencies, String userKey, String requesterEmail, String logData) Create new Check policies request.
CheckVulnerabilitiesRequest	newCheckVulnerabilitiesRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey)
CheckVulnerabilitiesRequest	newCheckVulnerabilitiesRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String requesterEmail) Create new Inventory Update request.
ConfigurationRequest	newConfigurationRequest(String orgToken, String product, String productVersion, String userKey)
ConfigurationRequest	newConfigurationRequest(String orgToken, String product, String productVersion, String userKey, String requesterEmail) Create new Inventory Update request.
GetDependencyDataRequest	newDependencyDataRequest(String orgToken, Collection<AgentProjectInfo> projects, String userKey) Create new Dependency Data request.
GetDependencyDataRequest	newDependencyDataRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey)
GetDependencyDataRequest	newDependencyDataRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String requesterEmail) Create new Dependency Data request.
SummaryScanRequest	newSummaryScanRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey)
SummaryScanRequest	newSummaryScanRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String requesterEmail) Create new Inventory Update request.
UpdateInventoryRequest	newUpdateInventoryRequest(String orgToken, Collection<AgentProjectInfo> projects, String userKey) Create new Inventory Update request.
UpdateInventoryRequest	newUpdateInventoryRequest(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey) Create new Inventory Update request.
UpdateInventoryRequest	newUpdateInventoryRequest(String orgToken, String requesterEmail, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey) Create new Inventory Update request.
UpdateInventoryRequest	newUpdateInventoryRequest(String orgToken, String requesterEmail, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, Boolean aggregateModules, Boolean preserveModuleStructure, String aggregateProjectName, String aggregateProjectToken) Create new Inventory Update request.
UpdateInventoryRequest	newUpdateInventoryRequest(String orgToken, UpdateType updateType, String requesterEmail, String product, String productVersion, Collection<AgentProjectInfo> projects, String userKey, String logData) Create new Inventory Update request.
protected <R> BaseRequest<R>	prepareRequest(BaseRequest<R> request, String orgToken, String requesterEmail, String product, String productVersion, String userKey, boolean aggregateModules, boolean preserveModuleStructure, String aggregateProjectName, String aggregateProjectToken, String logData)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestFactory

public RequestFactory(String agent,
                      String agentVersion,
                      String pluginVersion)

Constructor

Parameters:

agent - Agent type identifier.

agentVersion - Agent API version.

pluginVersion - Plugin version.

Method Detail

newUpdateInventoryRequest

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

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to update.

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

Returns:

Newly created request to update organization inventory.

newUpdateInventoryRequest

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

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to update.

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

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

Returns:

Newly created request to update organization inventory.

newUpdateInventoryRequest

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

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

updateType - Request UpdateType

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

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

projects - Projects status statement to update.

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

logData -

Returns:

Newly created request to update organization inventory.

newUpdateInventoryRequest

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

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

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

projects - Projects status statement to update.

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

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

Returns:

Newly created request to update organization inventory.

newUpdateInventoryRequest

public UpdateInventoryRequest newUpdateInventoryRequest(String orgToken,
                                                        String requesterEmail,
                                                        String product,
                                                        String productVersion,
                                                        Collection<AgentProjectInfo> projects,
                                                        String userKey,
                                                        Boolean aggregateModules,
                                                        Boolean preserveModuleStructure,
                                                        String aggregateProjectName,
                                                        String aggregateProjectToken)

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

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

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

projects - Projects status statement to update.

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

aggregateModules - to combine all pom modules into a single WhiteSource project with an aggregated dependency flat list (no hierarchy).

preserveModuleStructure - combine all pom modules to be dependencies of single project, each module will be represented as a parent of its dependencies.

aggregateProjectName - aggregate project name identifier.

aggregateProjectToken - aggregate project token identifier.

Returns:

Newly created request to update organization inventory.

newCheckPoliciesRequest

public CheckPoliciesRequest newCheckPoliciesRequest(String orgToken,
                                                    Collection<AgentProjectInfo> projects,
                                                    String userKey)

Create new Check policies request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

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

Returns:

Newly created request to check policies application.

newCheckPoliciesRequest

public CheckPoliciesRequest newCheckPoliciesRequest(String orgToken,
                                                    String product,
                                                    String productVersion,
                                                    Collection<AgentProjectInfo> projects,
                                                    String userKey,
                                                    String requesterEmail)

Deprecated. Use newCheckPolicyComplianceRequest(String, String, String, Collection, boolean, String)

Create new Check policies request.

Parameters:

orgToken - WhiteSource organization token.

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

projects - Projects status statement to check.

product - Name or WhiteSource service token of the product whose policies to check.

productVersion - Version of the product whose policies to check.

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

Returns:

Newly created request to check policies application.

newCheckPoliciesRequest

public CheckPoliciesRequest newCheckPoliciesRequest(String orgToken,
                                                    String product,
                                                    String productVersion,
                                                    Collection<AgentProjectInfo> projects,
                                                    String userKey)

newCheckPolicyComplianceRequest

public CheckPolicyComplianceRequest newCheckPolicyComplianceRequest(String orgToken,
                                                                    Collection<AgentProjectInfo> projects,
                                                                    boolean forceCheckAllDependencies,
                                                                    String userKey)

Create new Check policies request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

forceCheckAllDependencies - boolean check that all/added dependencies sent to WhiteSource

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

Returns:

Newly created request to check policies application.

newCheckPolicyComplianceRequest

public CheckPolicyComplianceRequest newCheckPolicyComplianceRequest(String orgToken,
                                                                    String product,
                                                                    String productVersion,
                                                                    Collection<AgentProjectInfo> projects,
                                                                    boolean forceCheckAllDependencies,
                                                                    String userKey,
                                                                    String requesterEmail)

Create new Check policies request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

product - Name or WhiteSource service token of the product whose policies to check.

productVersion - Version of the product whose policies to check.

forceCheckAllDependencies - boolean check that all/added dependencies sent to WhiteSource

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

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

Returns:

Newly created request to check policies application.

newCheckPolicyComplianceRequest

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

Create new Check policies request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

product - Name or WhiteSource service token of the product whose policies to check.

productVersion - Version of the product whose policies to check.

forceCheckAllDependencies - boolean check that all/added dependencies sent to WhiteSource

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

Returns:

Newly created request to check policies application.

newCheckPolicyComplianceRequest

public CheckPolicyComplianceRequest newCheckPolicyComplianceRequest(String orgToken,
                                                                    String product,
                                                                    String productVersion,
                                                                    Collection<AgentProjectInfo> projects,
                                                                    boolean forceCheckAllDependencies,
                                                                    String userKey)

newCheckPolicyComplianceRequest

public CheckPolicyComplianceRequest newCheckPolicyComplianceRequest(String orgToken,
                                                                    String product,
                                                                    String productVersion,
                                                                    Collection<AgentProjectInfo> projects,
                                                                    boolean forceCheckAllDependencies,
                                                                    String userKey,
                                                                    String requesterEmail,
                                                                    boolean aggregateModules,
                                                                    boolean preserveModuleStructure,
                                                                    String aggregateProjectName,
                                                                    String aggregateProjectToken)

Create new Check policies request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

product - Name or WhiteSource service token of the product whose policies to check.

productVersion - Version of the product whose policies to check.

forceCheckAllDependencies - boolean check that all/added dependencies sent to WhiteSource

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

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

aggregateModules - to combine all pom modules into a single WhiteSource project with an aggregated dependency flat list (no hierarchy).

preserveModuleStructure - combine all pom modules to be dependencies of single project, each module will be represented as a parent of its dependencies.

aggregateProjectName - aggregate project name identifier.

aggregateProjectToken - aggregate project token identifier.

Returns:

Newly created request to check policies application.

newDependencyDataRequest

public GetDependencyDataRequest newDependencyDataRequest(String orgToken,
                                                         Collection<AgentProjectInfo> projects,
                                                         String userKey)

Create new Dependency Data request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

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

Returns:

Newly created request to get Dependency Additional Data (Licenses, Description, homepageUrl and Vulnerabilities).

newDependencyDataRequest

public GetDependencyDataRequest newDependencyDataRequest(String orgToken,
                                                         String product,
                                                         String productVersion,
                                                         Collection<AgentProjectInfo> projects,
                                                         String userKey,
                                                         String requesterEmail)

Create new Dependency Data request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to check.

product - Name or WhiteSource service token of the product whose policies to check.

productVersion - Version of the product whose policies to check.

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

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

Returns:

Newly created request to get Dependency Additional Data (Licenses, Description, homepageUrl and Vulnerabilities).

newDependencyDataRequest

public GetDependencyDataRequest newDependencyDataRequest(String orgToken,
                                                         String product,
                                                         String productVersion,
                                                         Collection<AgentProjectInfo> projects,
                                                         String userKey)

newSummaryScanRequest

public SummaryScanRequest newSummaryScanRequest(String orgToken,
                                                String product,
                                                String productVersion,
                                                Collection<AgentProjectInfo> projects,
                                                String userKey,
                                                String requesterEmail)

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to update.

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

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

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

Returns:

Newly created request to update organization inventory.

newSummaryScanRequest

public SummaryScanRequest newSummaryScanRequest(String orgToken,
                                                String product,
                                                String productVersion,
                                                Collection<AgentProjectInfo> projects,
                                                String userKey)

newCheckVulnerabilitiesRequest

public CheckVulnerabilitiesRequest newCheckVulnerabilitiesRequest(String orgToken,
                                                                  String product,
                                                                  String productVersion,
                                                                  Collection<AgentProjectInfo> projects,
                                                                  String userKey,
                                                                  String requesterEmail)

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

projects - Projects status statement to update.

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

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

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

Returns:

Newly created request to update organization inventory.

newCheckVulnerabilitiesRequest

public CheckVulnerabilitiesRequest newCheckVulnerabilitiesRequest(String orgToken,
                                                                  String product,
                                                                  String productVersion,
                                                                  Collection<AgentProjectInfo> projects,
                                                                  String userKey)

newConfigurationRequest

public ConfigurationRequest newConfigurationRequest(String orgToken,
                                                    String product,
                                                    String productVersion,
                                                    String userKey,
                                                    String requesterEmail)

Create new Inventory Update request.

Parameters:

orgToken - WhiteSource organization token.

product - Name or WhiteSource service token of the product to update.

productVersion - Version of the product to update.

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

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

Returns:

request to get organization plugin configuration.

newConfigurationRequest

public ConfigurationRequest newConfigurationRequest(String orgToken,
                                                    String product,
                                                    String productVersion,
                                                    String userKey)

prepareRequest

protected <R> BaseRequest<R> prepareRequest(BaseRequest<R> request,
                                            String orgToken,
                                            String requesterEmail,
                                            String product,
                                            String productVersion,
                                            String userKey,
                                            boolean aggregateModules,
                                            boolean preserveModuleStructure,
                                            String aggregateProjectName,
                                            String aggregateProjectToken,
                                            String logData)