org.argeo.cms/src/org/argeo/cms/internal/backup/AtomicBackup.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.cms.internal.backup;
  17
  18 import org.apache.commons.vfs2.FileSystemManager;
  19 import org.apache.commons.vfs2.FileSystemOptions;
  20
  21 /** Performs the backup of a single component, typically a database dump */
  22 public interface AtomicBackup {
  23         /** Name identifiying this backup */
  24         public String getName();
  25
  26         /**
  27          * Retrieves the data of the component in a format that allows to restore
  28          * the component
  29          *
  30          * @param backupContext
  31          *            the context of this backup
  32          * @return the VFS URI of the generated file or directory
  33          */
  34         public String backup(FileSystemManager fileSystemManager,
  35                         String backupsBase, BackupContext backupContext,
  36                         FileSystemOptions opts);
  37 }