org.whitesource.agent.client

Interface WssServiceClient

All Known Implementing Classes:

WssServiceClientImpl

public interface WssServiceClient

The interface describes the functionality to be exposed by a client implementation to the White Source agent service.

Author:

Edo.Shor, Tom.Shapira

Method Summary

Modifier and Type	Method and Description
CheckPoliciesResult	checkPolicies(CheckPoliciesRequest request) Deprecated. Use checkPolicyCompliance(CheckPolicyComplianceRequest)
CheckPolicyComplianceResult	checkPolicyCompliance(CheckPolicyComplianceRequest request) The method call the White Source service for checking policies application.
CheckVulnerabilitiesResult	checkVulnerabilities(CheckVulnerabilitiesRequest request) The method calls the White Source service for check vulnerabilities.
GetDependencyDataResult	getDependencyData(GetDependencyDataRequest request) The method call the White Source service for getting additional dependency data.
void	setConnectionTimeout(int timeout) The method adjust the connection timeout limit to White Source servers.
void	setProxy(String host, int port, String username, String password) The method configure the client to use a proxy specified by the given parameters.
void	shutdown()
SummaryScanResult	summaryScan(SummaryScanRequest request) The method calls the White Source service for inventory update.
UpdateInventoryResult	updateInventory(UpdateInventoryRequest request) The method calls the White Source service for inventory update.

Method Detail

updateInventory

UpdateInventoryResult updateInventory(UpdateInventoryRequest request)
                               throws WssServiceException

The method calls the White Source service for inventory update.

Parameters:

request - Inventory update request.

Returns:

Inventory update result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

checkPolicies

CheckPoliciesResult checkPolicies(CheckPoliciesRequest request)
                           throws WssServiceException

Deprecated. Use checkPolicyCompliance(CheckPolicyComplianceRequest)

The method call the White Source service for checking policies application.

Parameters:

request - Check Policies request.

Returns:

Check Policies result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

checkPolicyCompliance

CheckPolicyComplianceResult checkPolicyCompliance(CheckPolicyComplianceRequest request)
                                           throws WssServiceException

The method call the White Source service for checking policies application.

Parameters:

request - Check Policies request.

Returns:

Check Policies result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

getDependencyData

GetDependencyDataResult getDependencyData(GetDependencyDataRequest request)
                                   throws WssServiceException

The method call the White Source service for getting additional dependency data.

Parameters:

request - Get Dependency Data request.

Returns:

Get Dependency Data result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

summaryScan

SummaryScanResult summaryScan(SummaryScanRequest request)
                       throws WssServiceException

The method calls the White Source service for inventory update.

Parameters:

request - Inventory update request.

Returns:

Inventory update result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

checkVulnerabilities

CheckVulnerabilitiesResult checkVulnerabilities(CheckVulnerabilitiesRequest request)
                                         throws WssServiceException

The method calls the White Source service for check vulnerabilities.

Parameters:

request - Check vulnerabilities request.

Returns:

Vulnerabilities report result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

shutdown

void shutdown()

setProxy

void setProxy(String host,
              int port,
              String username,
              String password)

The method configure the client to use a proxy specified by the given parameters.

Parameters:

host - Proxy host address.

port - Proxy port.

username - Optional. Proxy username.

password - Optional. Proxy password.

setConnectionTimeout

void setConnectionTimeout(int timeout)

The method adjust the connection timeout limit to White Source servers.

Parameters:

timeout - In milliseconds.