org.owasp.dependencycheck.data.update

Interface CachedWebDataSource

All Known Implementing Classes:

EngineVersionCheck, HostedSuppressionsDataSource, KnownExploitedDataSource, NvdApiDataSource, RetireJSDataSource

public interface CachedWebDataSource

Defines a data source who's data is retrieved from the Internet. This data can be downloaded and the local cache updated.

Author:

Jeremy Long

Method Summary

Modifier and Type	Method and Description
boolean	purge(Engine engine) Deletes any locally cached data.
boolean	update(Engine engine) Determines if an update to the current data store is needed, if it is the new data is downloaded from the Internet and imported into the current cached data store.

Method Detail

update

boolean update(Engine engine)
        throws UpdateException

Determines if an update to the current data store is needed, if it is the new data is downloaded from the Internet and imported into the current cached data store.

Parameters:

engine - a reference to the dependency-check engine

Returns:

whether or not an update was made to the CveDB

Throws:

UpdateException - is thrown if there is an exception downloading the data or updating the data store.

purge

boolean purge(Engine engine)

Deletes any locally cached data.

Parameters:

engine - a reference to the dependency-check engine

Returns:

true if the purge was successful; otherwise false