| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| CachedWebDataSource |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * This file is part of dependency-check-core. | |
| 3 | * | |
| 4 | * Dependency-check-core is free software: you can redistribute it and/or modify it | |
| 5 | * under the terms of the GNU General Public License as published by the Free | |
| 6 | * Software Foundation, either version 3 of the License, or (at your option) any | |
| 7 | * later version. | |
| 8 | * | |
| 9 | * Dependency-check-core is distributed in the hope that it will be useful, but | |
| 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more | |
| 12 | * details. | |
| 13 | * | |
| 14 | * You should have received a copy of the GNU General Public License along with | |
| 15 | * dependency-check-core. If not, see http://www.gnu.org/licenses/. | |
| 16 | * | |
| 17 | * Copyright (c) 2012 Jeremy Long. All Rights Reserved. | |
| 18 | */ | |
| 19 | package org.owasp.dependencycheck.data; | |
| 20 | ||
| 21 | /** | |
| 22 | * Defines an Index who's data is retrieved from the Internet. This data can be | |
| 23 | * downloaded and the index updated. | |
| 24 | * | |
| 25 | * @author Jeremy Long (jeremy.long@owasp.org) | |
| 26 | */ | |
| 27 | public interface CachedWebDataSource { | |
| 28 | ||
| 29 | /** | |
| 30 | * Determines if an update to the current index is needed, if it is the new | |
| 31 | * data is downloaded from the Internet and imported into the current Lucene | |
| 32 | * Index. | |
| 33 | * | |
| 34 | * @throws UpdateException is thrown if there is an exception updating the | |
| 35 | * index. | |
| 36 | */ | |
| 37 | void update() throws UpdateException; | |
| 38 | } |