org.exist.backup
Interface BackupDescriptor

All Known Implementing Classes:

AbstractBackupDescriptor, FileSystemBackupDescriptor, ZipArchiveBackupDescriptor

public interface BackupDescriptor

Field Summary

static java.lang.String	BACKUP_PROPERTIES
static java.lang.String	COLLECTION_DESCRIPTOR
static java.lang.String	DATE_PROP_NAME
static java.lang.String	INCREMENTAL_PROP_NAME
static java.lang.String	NUMBER_IN_SEQUENCE_PROP_NAME
static java.lang.String	PREVIOUS_PROP_NAME

Method Summary

boolean	before(long timestamp)
BackupDescriptor	getBackupDescriptor(java.lang.String describedItem)
BackupDescriptor	getChildBackupDescriptor(java.lang.String describedItem)
java.util.Date	getDate()
EXistInputSource	getInputSource()
EXistInputSource	getInputSource(java.lang.String describedItem)
java.lang.String	getName()
java.io.File	getParentDir()
java.util.Properties	getProperties() Returns general properties of the backup, normally including the creation date or if it is an incremental backup.
java.lang.String	getSymbolicPath()
java.lang.String	getSymbolicPath(java.lang.String describedItem, boolean isChildDescriptor)
void	parse(org.xml.sax.ContentHandler handler)

Field Detail

COLLECTION_DESCRIPTOR

static final java.lang.String COLLECTION_DESCRIPTOR

See Also:

Constant Field Values

BACKUP_PROPERTIES

static final java.lang.String BACKUP_PROPERTIES

See Also:

Constant Field Values

PREVIOUS_PROP_NAME

static final java.lang.String PREVIOUS_PROP_NAME

See Also:

Constant Field Values

NUMBER_IN_SEQUENCE_PROP_NAME

static final java.lang.String NUMBER_IN_SEQUENCE_PROP_NAME

See Also:

Constant Field Values

INCREMENTAL_PROP_NAME

static final java.lang.String INCREMENTAL_PROP_NAME

See Also:

Constant Field Values

DATE_PROP_NAME

static final java.lang.String DATE_PROP_NAME

See Also:

Constant Field Values

Method Detail

getInputSource

EXistInputSource getInputSource()

getInputSource

EXistInputSource getInputSource(java.lang.String describedItem)

getChildBackupDescriptor

BackupDescriptor getChildBackupDescriptor(java.lang.String describedItem)

getBackupDescriptor

BackupDescriptor getBackupDescriptor(java.lang.String describedItem)

getName

java.lang.String getName()

getSymbolicPath

java.lang.String getSymbolicPath()

getSymbolicPath

java.lang.String getSymbolicPath(java.lang.String describedItem,
                                 boolean isChildDescriptor)

getProperties

java.util.Properties getProperties()
                                   throws java.io.IOException

Returns general properties of the backup, normally including the creation date or if it is an incremental backup.

Returns:

a Properties object or null if no properties were found

Throws:

java.io.IOException - if there was an error in the properties file

getParentDir

java.io.File getParentDir()

getDate

java.util.Date getDate()

before

boolean before(long timestamp)

parse

void parse(org.xml.sax.ContentHandler handler)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException