BackupDescriptor.java

package org.exist.backup;

import org.exist.util.EXistInputSource;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;

import javax.xml.parsers.ParserConfigurationException;
import java.util.Properties;
import java.util.Date;
import java.io.IOException;
import java.io.File;

public interface BackupDescriptor {
	public final static String COLLECTION_DESCRIPTOR="__contents__.xml";

    public final static String BACKUP_PROPERTIES = "backup.properties";

    public final static String PREVIOUS_PROP_NAME = "previous";
    public final static String NUMBER_IN_SEQUENCE_PROP_NAME = "nr-in-sequence";
    public final static String INCREMENTAL_PROP_NAME = "incremental";
    public final static String DATE_PROP_NAME = "date";

    public Object getContent(String fileName);
    
	public EXistInputSource getInputSource();
	
	public EXistInputSource getInputSource(String describedItem);
	
	public BackupDescriptor getChildBackupDescriptor(String describedItem);

    public BackupDescriptor getBackupDescriptor(String describedItem);
    
    public String getName();
    
	public String getSymbolicPath();
	
	public String getSymbolicPath(String describedItem,boolean isChildDescriptor);

    /**
     * Returns general properties of the backup, normally including the creation date
     * or if it is an incremental backup.
     *
     * @return a Properties object or null if no properties were found
     * @throws IOException if there was an error in the properties file
     */
    public Properties getProperties() throws IOException;

    public File getParentDir();

    public Date getDate();

    public boolean before(long timestamp);

    public void parse(ContentHandler handler) throws IOException, SAXException, ParserConfigurationException; 
}