org.exist.backup
Interface BackupDescriptor

All Known Implementing Classes:

AbstractBackupDescriptor, FileSystemBackupDescriptor, ZipArchiveBackupDescriptor

public interface BackupDescriptor

Field Summary

static String	BACKUP_PROPERTIES
static String	COLLECTION_DESCRIPTOR
static String	DATE_PROP_NAME
static String	INCREMENTAL_PROP_NAME
static String	NUMBER_IN_SEQUENCE_PROP_NAME
static String	PREVIOUS_PROP_NAME

Method Summary

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

Field Detail

COLLECTION_DESCRIPTOR

static final String COLLECTION_DESCRIPTOR

See Also:

Constant Field Values

BACKUP_PROPERTIES

static final String BACKUP_PROPERTIES

See Also:

Constant Field Values

PREVIOUS_PROP_NAME

static final String PREVIOUS_PROP_NAME

See Also:

Constant Field Values

NUMBER_IN_SEQUENCE_PROP_NAME

static final String NUMBER_IN_SEQUENCE_PROP_NAME

See Also:

Constant Field Values

INCREMENTAL_PROP_NAME

static final String INCREMENTAL_PROP_NAME

See Also:

Constant Field Values

DATE_PROP_NAME

static final String DATE_PROP_NAME

See Also:

Constant Field Values

Method Detail

getInputSource

EXistInputSource getInputSource()

getInputSource

EXistInputSource getInputSource(String describedItem)

getChildBackupDescriptor

BackupDescriptor getChildBackupDescriptor(String describedItem)

getBackupDescriptor

BackupDescriptor getBackupDescriptor(String describedItem)

getName

String getName()

getSymbolicPath

String getSymbolicPath()

getSymbolicPath

String getSymbolicPath(String describedItem,
                       boolean isChildDescriptor)

getProperties

Properties getProperties()
                         throws 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:

IOException - if there was an error in the properties file

getParentDir

File getParentDir()

getDate

Date getDate()

before

boolean before(long timestamp)

parse

void parse(ContentHandler handler)
           throws IOException,
                  SAXException,
                  ParserConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException