org.owasp.dependencycheck.data.update

Class HostedSuppressionsDataSource

java.lang.Object

org.owasp.dependencycheck.data.update.HostedSuppressionsDataSource

All Implemented Interfaces:

CachedWebDataSource

public class HostedSuppressionsDataSource
extends java.lang.Object
implements CachedWebDataSource

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SUPPRESSIONS_URL The default URL to the Hosted Suppressions file.

Constructor Summary

Constructors

Constructor and Description
HostedSuppressionsDataSource()

Method Summary

Modifier and Type	Method and Description
boolean	purge(Engine engine) Deletes any locally cached data.
protected boolean	shouldUpdate(java.io.File repo) Determines if the we should update the Hosted Suppressions file.
boolean	update(Engine engine) Downloads the current Hosted suppressions file.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUPPRESSIONS_URL

public static final java.lang.String DEFAULT_SUPPRESSIONS_URL

The default URL to the Hosted Suppressions file.

See Also:

Constant Field Values

Constructor Detail

HostedSuppressionsDataSource

public HostedSuppressionsDataSource()

Method Detail

update

public boolean update(Engine engine)
               throws UpdateException

Downloads the current Hosted suppressions file.

Specified by:

update in interface CachedWebDataSource

Parameters:

engine - a reference to the ODC Engine

Returns:

returns false as no updates are made to the database, just web resources cached locally

Throws:

UpdateException - thrown if the update encountered fatal errors

shouldUpdate

protected boolean shouldUpdate(java.io.File repo)
                        throws java.lang.NumberFormatException

Determines if the we should update the Hosted Suppressions file.

Parameters:

repo - the Hosted Suppressions file.

Returns:

true if an update to the Hosted Suppressions file should be performed; otherwise false

Throws:

java.lang.NumberFormatException - thrown if an invalid value is contained in the database properties

purge

public boolean purge(Engine engine)

Description copied from interface: CachedWebDataSource

Deletes any locally cached data.

Specified by:

purge in interface CachedWebDataSource

Parameters:

engine - a reference to the dependency-check engine

Returns:

true if the purge was successful; otherwise false