org.objectweb.cjdbc.controller.backup
Class BackupManager

java.lang.Object
  org.objectweb.cjdbc.controller.backup.BackupManager

All Implemented Interfaces:

XmlComponent

public class BackupManager

extends java.lang.Object

implements XmlComponent

This class defines a BackupManager that is responsible for registering backupers and retrieving them as needed for backup/restore operations.

Version:

1.0

Author:

Emmanuel Cecchet

Field Summary

private java.util.HashMap	backupers This is a HashMap of backuperName -> Backuper HashMap
(package private) static Trace	logger

Fields inherited from interface org.objectweb.cjdbc.common.xml.XmlComponent

DOCTYPE_CONTROLLER, DOCTYPE_DB, XML_VERSION

Constructor Summary

BackupManager()
Creates a new BackupManager object

Method Summary

Backuper	getBackuperByFormat(java.lang.String format) Get the first backuper that supports the given dump format.
Backuper	getBackuperByName(java.lang.String name) Retrieve a backuper given its name.
java.lang.String[]	getBackuperNames() Get the names of the Backupers available from this BackupManager.
java.lang.String	getXml() Get xml formatted representation of this cjdbc component
void	registerBackuper(java.lang.String name, Backuper backuper) Register a new backuper under a logical name.
boolean	unregisterBackuper(java.lang.String name) Unregister a Backuper given its logical name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

static Trace logger

backupers

private java.util.HashMap backupers

This is a HashMap of backuperName -> Backuper HashMap

Constructor Detail

BackupManager

public BackupManager()

Creates a new BackupManager object

Method Detail

getBackuperByName

public Backuper getBackuperByName(java.lang.String name)

Retrieve a backuper given its name. If the backuper has not been registered null is returned.

Parameters:

name - the backuper to look for

Returns:

the backuper or null if not found

getBackuperNames

public java.lang.String[] getBackuperNames()

Get the names of the Backupers available from this BackupManager.

Returns:

an (possibly 0-sized) array of String representing the name of the Backupers

getBackuperByFormat

public Backuper getBackuperByFormat(java.lang.String format)

Get the first backuper that supports the given dump format. If no backuper supporting that format can be found, null is returned.

Parameters:

format - the dump format that the backuper must handle

Returns:

a backuper or null if not found

registerBackuper

public void registerBackuper(java.lang.String name,
                             Backuper backuper)
                      throws BackupException

Register a new backuper under a logical name.

Parameters:

name - backuper logical name

backuper - the backuper instance

Throws:

BackupException - if a backuper is null or a backuper has already been registered with the given name.

unregisterBackuper

public boolean unregisterBackuper(java.lang.String name)

Unregister a Backuper given its logical name.

Parameters:

name - the name of the backuper to unregister

Returns:

true if the backuper was removed successfully, false if it was not registered

getXml

public java.lang.String getXml()

Description copied from interface: XmlComponent

Get xml formatted representation of this cjdbc component

Specified by:

getXml in interface XmlComponent

Returns:

xml formatted fragment

See Also:

XmlComponent.getXml()