1 /*
2 * This file is part of dependency-check-core.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 * Copyright (c) 2012 Jeremy Long. All Rights Reserved.
17 */
18 package org.owasp.dependencycheck.data.update;
19
20 import org.owasp.dependencycheck.data.update.exception.UpdateException;
21
22 /**
23 * Defines a data source who's data is retrieved from the Internet. This data can be downloaded and the local cache
24 * updated.
25 *
26 * @author Jeremy Long
27 */
28 public interface CachedWebDataSource {
29
30 /**
31 * Determines if an update to the current data store is needed, if it is the new data is downloaded from the
32 * Internet and imported into the current cached data store.
33 *
34 * @throws UpdateException is thrown if there is an exception downloading the data or updating the data store.
35 */
36 void update() throws UpdateException;
37 }