View Javadoc

1   package org.apache.continuum.purge;
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.continuum.model.repository.DirectoryPurgeConfiguration;
23  import org.apache.continuum.model.repository.DistributedDirectoryPurgeConfiguration;
24  import org.apache.continuum.model.repository.RepositoryPurgeConfiguration;
25  import org.apache.maven.continuum.model.project.Schedule;
26  
27  /**
28   * @author Maria Catherine Tan
29   * @version $Id: ContinuumPurgeManager.java 1372260 2012-08-13 04:29:09Z brett $
30   * @since 25 jul 07
31   */
32  public interface ContinuumPurgeManager
33  {
34      String ROLE = ContinuumPurgeManager.class.getName();
35  
36      /**
37       * Purge repositories and directories
38       *
39       * @param schedule
40       * @throws ContinuumPurgeManagerException
41       */
42      void purge( Schedule schedule )
43          throws ContinuumPurgeManagerException;
44  
45      /**
46       * Purge repository
47       *
48       * @param repoPurgeConfig
49       * @throws ContinuumPurgeManagerException
50       */
51      void purgeRepository( RepositoryPurgeConfiguration repoPurgeConfig )
52          throws ContinuumPurgeManagerException;
53  
54      /**
55       * Purge directory
56       *
57       * @param dirPurgeConfig
58       * @throws ContinuumPurgeManagerException
59       */
60      void purgeDirectory( DirectoryPurgeConfiguration dirPurgeConfig )
61          throws ContinuumPurgeManagerException;
62  
63      /**
64       * Purge directory in distributed build mode
65       *
66       * @param dirPurgeConfig distributed purge configuration
67       * @throws ContinuumPurgeManagerException
68       */
69      void purgeDistributedDirectory( DistributedDirectoryPurgeConfiguration dirPurgeConfig )
70          throws ContinuumPurgeManagerException;
71  }