Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
DatabaseUpdater |
|
| 1.0;1 |
1 | package org.apache.maven.archiva.database.updater; | |
2 | ||
3 | /* | |
4 | * Licensed to the Apache Software Foundation (ASF) under one | |
5 | * or more contributor license agreements. See the NOTICE file | |
6 | * distributed with this work for additional information | |
7 | * regarding copyright ownership. The ASF licenses this file | |
8 | * to you under the Apache License, Version 2.0 (the | |
9 | * "License"); you may not use this file except in compliance | |
10 | * with the License. You may obtain a copy of the License at | |
11 | * | |
12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
13 | * | |
14 | * Unless required by applicable law or agreed to in writing, | |
15 | * software distributed under the License is distributed on an | |
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
17 | * KIND, either express or implied. See the License for the | |
18 | * specific language governing permissions and limitations | |
19 | * under the License. | |
20 | */ | |
21 | ||
22 | import org.apache.maven.archiva.database.ArchivaDatabaseException; | |
23 | import org.apache.maven.archiva.model.ArchivaArtifact; | |
24 | ||
25 | /** | |
26 | * The database update component. | |
27 | * | |
28 | * @version $Id: DatabaseUpdater.java 718864 2008-11-19 06:33:35Z brett $ | |
29 | */ | |
30 | public interface DatabaseUpdater | |
31 | { | |
32 | /** | |
33 | * Execute the {@link #updateAllUnprocessed()} and {@link #updateAllProcessed()} | |
34 | * tasks in one go. | |
35 | * | |
36 | * @throws ArchivaDatabaseException | |
37 | */ | |
38 | public void update() | |
39 | throws ArchivaDatabaseException; | |
40 | ||
41 | /** | |
42 | * Update all unprocessed content. | |
43 | * | |
44 | * @throws ArchivaDatabaseException if there was a fatal error with the database. | |
45 | */ | |
46 | public void updateAllUnprocessed() | |
47 | throws ArchivaDatabaseException; | |
48 | ||
49 | /** | |
50 | * Update specific unprocessed content. | |
51 | * | |
52 | * @throws ArchivaDatabaseException if there was a fatal error with the database. | |
53 | */ | |
54 | public void updateUnprocessed( ArchivaArtifact artifact ) | |
55 | throws ArchivaDatabaseException; | |
56 | ||
57 | /** | |
58 | * Update all previously processed content. | |
59 | * | |
60 | * This is done to allow archiva to remove content from the database that | |
61 | * may have been removed from the filesystem too. | |
62 | * | |
63 | * @throws ArchivaDatabaseException if there was a fatal error with the database. | |
64 | */ | |
65 | public void updateAllProcessed() | |
66 | throws ArchivaDatabaseException; | |
67 | ||
68 | /** | |
69 | * Update specific processed content. | |
70 | * | |
71 | * Example: This is done to allow a specific artifact to be removed from the | |
72 | * database if it no longer exists on the filesystem. | |
73 | * | |
74 | * @throws ArchivaDatabaseException if there was a fatal error with the database. | |
75 | */ | |
76 | public void updateProcessed( ArchivaArtifact artifact ) | |
77 | throws ArchivaDatabaseException; | |
78 | } |