org.whitesource.agent.client

Class WhitesourceService

java.lang.Object

org.whitesource.agent.client.WhitesourceService

public class WhitesourceService
extends Object

A facade to the communication layer with the White Source service.

Author:

Edo.Shor

Constructor Summary

Constructors

Constructor and Description
WhitesourceService()
WhitesourceService(String agent, String agentVersion, String pluginVersion)
WhitesourceService(String agent, String agentVersion, String serviceUrl, boolean setProxy)
WhitesourceService(String agent, String agentVersion, String serviceUrl, boolean setProxy, int connectionTimeoutMinutes)
WhitesourceService(String agent, String agentVersion, String pluginVersion, String serviceUrl)
WhitesourceService(String agent, String agentVersion, String pluginVersion, String serviceUrl, boolean setProxy)
WhitesourceService(String agent, String agentVersion, String pluginVersion, String serviceUrl, boolean setProxy, int connectionTimeoutMinutes)
WhitesourceService(String agent, String agentVersion, String pluginVersion, String serviceUrl, boolean setProxy, int connectionTimeoutMinutes, boolean ignoreCertificateCheck)

Method Summary

Modifier and Type	Method and Description
CheckPoliciesResult	checkPolicies(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Deprecated. Use checkPolicyCompliance(String, String, String, Collection, boolean).
CheckPolicyComplianceResult	checkPolicyCompliance(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos, boolean forceCheckAllDependencies) Checks the policies application of the given OSS information.
CheckVulnerabilitiesResult	checkVulnerabilities(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Gets vulnerabilities data for given dependencies.
WssServiceClient	getClient()
GetDependencyDataResult	getDependencyData(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Gets additional data for given dependencies.
RequestFactory	getRequestFactory()
UpdateInventoryRequest	offlineUpdate(String orgToken, String product, Boolean removeBeforeAdd, String productVersion, Collection<AgentProjectInfo> projectInfos) Generates a file with json representation of the update request.
UpdateInventoryRequest	offlineUpdate(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Generates a file with json representation of the update request.
void	setClient(WssServiceClient client)
void	setRequestFactory(RequestFactory requestFactory)
void	shutdown() The method close the underlying client to the White Source service.
SummaryScanResult	summaryScan(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Updates the White Source organization account with the given OSS information.
UpdateInventoryResult	update(String orgToken, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Updates the White Source organization account with the given OSS information.
UpdateInventoryResult	update(String orgToken, String requesterEmail, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Updates the White Source organization account with the given OSS information.
UpdateInventoryResult	update(String orgToken, String requesterEmail, UpdateType updateType, String product, String productVersion, Collection<AgentProjectInfo> projectInfos) Updates the White Source organization account with the given OSS information.

Methods inherited from class java.lang.Object

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

Constructor Detail

WhitesourceService

public WhitesourceService()

WhitesourceService

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

WhitesourceService

public WhitesourceService(String agent,
                          String agentVersion,
                          String pluginVersion,
                          String serviceUrl)

WhitesourceService

public WhitesourceService(String agent,
                          String agentVersion,
                          String pluginVersion,
                          String serviceUrl,
                          boolean setProxy)

WhitesourceService

public WhitesourceService(String agent,
                          String agentVersion,
                          String pluginVersion,
                          String serviceUrl,
                          boolean setProxy,
                          int connectionTimeoutMinutes)

WhitesourceService

public WhitesourceService(String agent,
                          String agentVersion,
                          String pluginVersion,
                          String serviceUrl,
                          boolean setProxy,
                          int connectionTimeoutMinutes,
                          boolean ignoreCertificateCheck)

WhitesourceService

public WhitesourceService(String agent,
                          String agentVersion,
                          String serviceUrl,
                          boolean setProxy)

WhitesourceService

public WhitesourceService(String agent,
                          String agentVersion,
                          String serviceUrl,
                          boolean setProxy,
                          int connectionTimeoutMinutes)

Method Detail

update

public UpdateInventoryResult update(String orgToken,
                                    String product,
                                    String productVersion,
                                    Collection<AgentProjectInfo> projectInfos)
                             throws WssServiceException

Updates the White Source organization account with the given OSS information.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

Result of updating white source.

Throws:

WssServiceException - In case of errors while updating white source.

update

public UpdateInventoryResult update(String orgToken,
                                    String requesterEmail,
                                    String product,
                                    String productVersion,
                                    Collection<AgentProjectInfo> projectInfos)
                             throws WssServiceException

Updates the White Source organization account with the given OSS information.

Parameters:

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

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

Result of updating white source.

Throws:

WssServiceException

update

public UpdateInventoryResult update(String orgToken,
                                    String requesterEmail,
                                    UpdateType updateType,
                                    String product,
                                    String productVersion,
                                    Collection<AgentProjectInfo> projectInfos)
                             throws WssServiceException

Updates the White Source organization account with the given OSS information.

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.

projectInfos - OSS usage information to send to white source.

Returns:

Result of updating white source.

Throws:

WssServiceException

offlineUpdate

public UpdateInventoryRequest offlineUpdate(String orgToken,
                                            String product,
                                            Boolean removeBeforeAdd,
                                            String productVersion,
                                            Collection<AgentProjectInfo> projectInfos)

Generates a file with json representation of the update request.

Parameters:

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

product - The product name or token to update.

removeBeforeAdd - Should remove before add

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

UpdateInventoryRequest.

offlineUpdate

public UpdateInventoryRequest offlineUpdate(String orgToken,
                                            String product,
                                            String productVersion,
                                            Collection<AgentProjectInfo> projectInfos)

Generates a file with json representation of the update request.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

UpdateInventoryRequest.

checkPolicies

public CheckPoliciesResult checkPolicies(String orgToken,
                                         String product,
                                         String productVersion,
                                         Collection<AgentProjectInfo> projectInfos)
                                  throws WssServiceException

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

Checks the policies application of the given OSS information.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

Potential result of applying the currently defined policies.

Throws:

WssServiceException - In case of errors while checking the policies with white source.

checkPolicyCompliance

public CheckPolicyComplianceResult checkPolicyCompliance(String orgToken,
                                                         String product,
                                                         String productVersion,
                                                         Collection<AgentProjectInfo> projectInfos,
                                                         boolean forceCheckAllDependencies)
                                                  throws WssServiceException

Checks the policies application of the given OSS information.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

forceCheckAllDependencies - Boolean to check new data only or not.

Returns:

Potential result of applying the currently defined policies.

Throws:

WssServiceException - In case of errors while checking the policies with white source.

getDependencyData

public GetDependencyDataResult getDependencyData(String orgToken,
                                                 String product,
                                                 String productVersion,
                                                 Collection<AgentProjectInfo> projectInfos)
                                          throws WssServiceException

Gets additional data for given dependencies.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

Potential result of the dependencies additional data(license, description, homePageUrl, vulnerabilities, sha1 and displayName).

Throws:

WssServiceException - In case of errors while getting additional dependency data with white source.

summaryScan

public SummaryScanResult summaryScan(String orgToken,
                                     String product,
                                     String productVersion,
                                     Collection<AgentProjectInfo> projectInfos)
                              throws WssServiceException

Updates the White Source organization account with the given OSS information.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

Result of updating white source.

Throws:

WssServiceException

checkVulnerabilities

public CheckVulnerabilitiesResult checkVulnerabilities(String orgToken,
                                                       String product,
                                                       String productVersion,
                                                       Collection<AgentProjectInfo> projectInfos)
                                                throws WssServiceException

Gets vulnerabilities data for given dependencies.

Parameters:

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

product - The product name or token to update.

productVersion - The product version.

projectInfos - OSS usage information to send to white source.

Returns:

Vulnerabilities for given dependencies.

Throws:

WssServiceException

shutdown

public void shutdown()

The method close the underlying client to the White Source service.

See Also:

WssServiceClient.shutdown()

getClient

public WssServiceClient getClient()

setClient

public void setClient(WssServiceClient client)

getRequestFactory

public RequestFactory getRequestFactory()

setRequestFactory

public void setRequestFactory(RequestFactory requestFactory)