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   *
28   * @version $Id: DataManagementTool.java 1372260 2012-08-13 04:29:09Z brett $
29   */
30  public interface DataManagementTool
31  {
32      /**
33       * Backup the database.
34       *
35       * @param backupDirectory the directory to backup to
36       * @throws java.io.IOException     if there is a problem writing to the backup file
37       * @throws DataManagementException if there is a problem reading from the database
38       */
39      void backupDatabase( File backupDirectory )
40          throws IOException, DataManagementException;
41  
42      /**
43       * Restore the database.
44       *
45       * @param backupDirectory the directory where the backup to restore from resides
46       * @param strict
47       * @throws java.io.IOException     if there is a problem reading the backup file
48       * @throws DataManagementException if there is a problem parsing the backup file
49       */
50      void restoreDatabase( File backupDirectory, boolean strict )
51          throws IOException, DataManagementException;
52  
53      /**
54       * Smoke the database.
55       */
56      void eraseDatabase();
57  }