| org.continuent.sequoia.controller.backup.Backuper
All known Subclasses: org.continuent.sequoia.controller.backup.backupers.MSSQLBackuper, org.continuent.sequoia.controller.backup.backupers.OctopusBackuper, org.continuent.sequoia.controller.backup.backupers.DerbyEmbeddedBackuper, org.continuent.sequoia.controller.backup.backupers.AbstractBackuper,
| Backuper | | public interface Backuper (Code) | | This interface defines a Backuper that is in charge of doing backup/restore
operations and manage dumps according to its own internal format. The user
will manipulate logical names and the Backuper is responsible to maintain the
logical name/physical name mapping.
author:
Emmanuel Cecchet
version:
1.0 |
| Method Summary | |
| Date | backup(DatabaseBackend backend, String login, String password, String dumpName, String path, ArrayList tables)
Create a backup from the content of a backend. | | void | deleteDump(String path, String dumpName)
Delete the specified dump. | | void | fetchDump(DumpTransferInfo dumpTransferInfo, String path, String dumpName)
Client side: Fetch a remote dump from specified dump server. | | String | getDumpFormat()
Returns a String representing the format handled by this Backuper. | | String | getOptions()
Retrieve the backuper options that were used to initialize the backuper. | | void | restore(DatabaseBackend backend, String login, String password, String dumpName, String path, ArrayList tables)
Restore a dump on a specific backend. | | void | setOptions(String options)
Options that can be set at backuper initialization. | | DumpTransferInfo | setupDumpServer()
Server side: setup a server and returns a DumpTransferInfo suitable for
authenticated communication by a client using fetchDump(). |
| backup | | Date backup(DatabaseBackend backend, String login, String password, String dumpName, String path, ArrayList tables) throws BackupException(Code) | | Create a backup from the content of a backend.
Parameters:
backend - the target backend to backup
Parameters:
login - the login to use to connect to the database for the backupoperation
Parameters:
password - the password to use to connect to the database for thebackup operation
Parameters:
dumpName - the name of the dump to create
Parameters:
path - the path where to store the dump
Parameters:
tables - the list of tables to backup, null means all tables the timestamp for the dump if the backup was sucessful, nullotherwise
throws:
BackupException - if the backup operation fails |
| deleteDump | | void deleteDump(String path, String dumpName) throws BackupException(Code) | | Delete the specified dump.
Parameters:
path - the path where to retrieve the dump
Parameters:
dumpName - the dump to delete
throws:
BackupException - if we failed to delete the dump |
| fetchDump | | void fetchDump(DumpTransferInfo dumpTransferInfo, String path, String dumpName) throws BackupException, IOException(Code) | | Client side: Fetch a remote dump from specified dump server.
Parameters:
dumpTransferInfo - the address and session key of the dump server tocontact for fetching.
Parameters:
path - the path part of the remote dump spec (interpreted by server)
Parameters:
dumpName - the name part of the remote dump spec (interpreted byserver)
throws:
BackupException - in any error case: authentication error, transfererror, else.
throws:
IOException - if an error occurs during the transfer |
| getDumpFormat | | String getDumpFormat()(Code) | | Returns a String representing the format handled by this Backuper. This
field should be human readable and as detailed as possible so that no
confusion can be made by the administrator.
the Backuper specific format |
| restore | | void restore(DatabaseBackend backend, String login, String password, String dumpName, String path, ArrayList tables) throws BackupException(Code) | | Restore a dump on a specific backend.
Parameters:
backend - the target backend to restore to
Parameters:
login - the login to use to connect to the database for the restoreoperation
Parameters:
password - the password to use to connect to the database for therestore operation
Parameters:
dumpName - the name of the dump to restore
Parameters:
path - the path where to retrieve the dump
Parameters:
tables - the list of tables to restore, null means all tables
throws:
BackupException - if the restore operation failed |
| setOptions | | void setOptions(String options)(Code) | | Options that can be set at backuper initialization. These options are
provided in the definition of the Backuper element (see dtd).
Parameters:
options - Backuper specific options |
| setupDumpServer | | DumpTransferInfo setupDumpServer() throws IOException(Code) | | Server side: setup a server and returns a DumpTransferInfo suitable for
authenticated communication by a client using fetchDump().
a DumpTransferInfo to be used by a client for authenticatedcommunication upon fetchDump invocation.
throws:
IOException - if an error occurs during the transfer |
|
|