Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ArchivaTaskScheduler |
|
| 1.0;1 |
1 | package org.apache.maven.archiva.scheduled; | |
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.common.ArchivaException; | |
23 | import org.apache.maven.archiva.scheduled.tasks.ArtifactIndexingTask; | |
24 | import org.apache.maven.archiva.scheduled.tasks.DatabaseTask; | |
25 | import org.apache.maven.archiva.scheduled.tasks.RepositoryTask; | |
26 | import org.codehaus.plexus.taskqueue.TaskQueueException; | |
27 | import org.codehaus.plexus.taskqueue.execution.TaskExecutionException; | |
28 | ||
29 | /** | |
30 | * The component that takes care of scheduling in the application. | |
31 | * | |
32 | */ | |
33 | public interface ArchivaTaskScheduler | |
34 | { | |
35 | /** | |
36 | * The Plexus component role. | |
37 | */ | |
38 | public final static String ROLE = ArchivaTaskScheduler.class.getName(); | |
39 | ||
40 | /** | |
41 | * Checks if there is any database scanning task queued. | |
42 | * | |
43 | * @return | |
44 | * @throws ArchivaException | |
45 | */ | |
46 | public boolean isProcessingDatabaseTask(); | |
47 | ||
48 | /** | |
49 | * Checks if a repository scanning task for the specified repository is queued. | |
50 | * | |
51 | * @param repositoryId | |
52 | * @return | |
53 | * @throws ArchivaException | |
54 | */ | |
55 | public boolean isProcessingRepositoryTask( String repositoryId ); | |
56 | ||
57 | /** | |
58 | * Adds the database task to the database scanning queue. | |
59 | * | |
60 | * @param task | |
61 | * @throws TaskQueueException | |
62 | */ | |
63 | public void queueDatabaseTask( DatabaseTask task ) | |
64 | throws TaskQueueException; | |
65 | ||
66 | /** | |
67 | * Adds the repository task to the repo scanning queue. | |
68 | * | |
69 | * @param task | |
70 | * @throws TaskQueueException | |
71 | */ | |
72 | public void queueRepositoryTask( RepositoryTask task ) | |
73 | throws TaskQueueException; | |
74 | ||
75 | /** | |
76 | * Adds the indexing task to the indexing queue. | |
77 | * | |
78 | * @param task | |
79 | * @throws TaskQueueException | |
80 | */ | |
81 | public void queueIndexingTask( ArtifactIndexingTask task ) | |
82 | throws TaskQueueException; | |
83 | ||
84 | /** | |
85 | * Schedules the database tasks using the set cron expression. | |
86 | * | |
87 | * @throws TaskExecutionException | |
88 | */ | |
89 | public void scheduleDatabaseTasks() | |
90 | throws TaskExecutionException; | |
91 | ||
92 | public void startup() | |
93 | throws ArchivaException; | |
94 | } |