View Javadoc

1   package org.apache.maven.continuum.management;
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 java.io.File;
23  import java.io.IOException;
24  
25  /**
26   * Delegate to the correct data management tool.
27   * @version $Id: DataManagementTool.java 785095 2009-06-16 07:20:12Z ctan $
28   */
29  public interface DataManagementTool
30  {
31      /**
32       * Backup the database.
33       *
34       * @param backupDirectory the directory to backup to
35       * @throws java.io.IOException     if there is a problem writing to the backup file
36       * @throws DataManagementException if there is a problem reading from the database
37       */
38      void backupDatabase( File backupDirectory )
39          throws IOException, DataManagementException;
40  
41      /**
42       * Restore the database.
43       *
44       * @param backupDirectory the directory where the backup to restore from resides
45       * @param strict
46       * @throws java.io.IOException     if there is a problem reading the backup file
47       * @throws DataManagementException if there is a problem parsing the backup file
48       */
49      void restoreDatabase( File backupDirectory, boolean strict )
50          throws IOException, DataManagementException;
51  
52      /**
53       * Smoke the database.
54       */
55      void eraseDatabase();
56  }