org.exist.xmldb.EXistCollectionManagementService Maven / Gradle / Ivy

Go to download
/*
 * eXist Open Source Native XML Database
 * Copyright (C) 2001-2015 The eXist Project
 * http://exist-db.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.exist.xmldb;

import java.util.Date;

import org.xmldb.api.base.Collection;
import org.xmldb.api.base.XMLDBException;
import org.xmldb.api.modules.CollectionManagementService;


/**
 * Extends the {@link org.xmldb.api.modules.CollectionManagementService}
 * interface with extensions specific to eXist, in particular moving and copying
 * collections and resources.
 *
 * @author wolf
 */
public interface EXistCollectionManagementService extends CollectionManagementService {

    /**
     * Move a Collection.
     *
     * @param collection the source collection.
     * @param destination the destination collection.
     * @param newName the new name in the destination collection.
     *
     * @deprecated Use XmldbURI version instead.
     *
     * @throws XMLDBException if an error occurs when moving the collection.
     */
    @Deprecated
    void move(String collection, String destination, String newName) throws XMLDBException;

    /**
     * Move a Resource.
     *
     * @param resourcePath the source resource.
     * @param destinationPath the destination collection.
     * @param newName the new name in the destination collection.
     *
     * @deprecated Use XmldbURI version instead.
     *
     * @throws XMLDBException if an error occurs when moving the resource.
     */
    @Deprecated
    void moveResource(String resourcePath, String destinationPath, String newName) throws XMLDBException;

    /**
     * Copy a Resource.
     *
     * @param resourcePath the source resource.
     * @param destinationPath the destination collection.
     * @param newName the new name in the destination collection.
     *
     * @deprecated Use XmldbURI version instead.
     *
     * @throws XMLDBException if an error occurs when copying the resource.
     */
    @Deprecated
    void copyResource(String resourcePath, String destinationPath, String newName) throws XMLDBException;

    /**
     * Copy a Collection.
     *
     * @param collection the source collection.
     * @param destination the destination collection.
     * @param newName the new name in the destination collection.
     *
     * @deprecated Use XmldbURI version instead.
     *
     * @throws XMLDBException if an error occurs when copying the collection.
     */
    @Deprecated
    void copy(String collection, String destination, String newName) throws XMLDBException;

    /**
     * Create a Collection.
     *
     * @param collName the name of the collection.
     * @param created the created time of the collection.
     *
     * @return the newly created collection.
     *
     * @throws XMLDBException if an error occurs when creating the collection.
     *
     * @deprecated Use XmldbURI version instead
     */
    @Deprecated
    Collection createCollection(String collName, Date created) throws XMLDBException;

    void move(XmldbURI collection, XmldbURI destination, XmldbURI newName) throws XMLDBException;

    void moveResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName) throws XMLDBException;

    /**
     * Copy a Resource.
     *
     * @param resourcePath the source resource.
     * @param destinationPath the destination collection.
     * @param newName the new name in the destination collection.
     *
     * @deprecated Use {@link #copyResource(XmldbURI, XmldbURI, XmldbURI, String)}
     *
     * @throws XMLDBException if an error occurs when copying the resource.
     */
    @Deprecated
    void copyResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName) throws XMLDBException;

    /**
     * Copy a Resource.
     *
     * @param resourcePath The source document
     * @param destinationPath The destination collection
     * @param newName The new name of the copied source in the destination collection
     * @param preserveType one of either "DEFAULT", "NO_PRESERVE", "PRESERVE"
     *
     * @throws XMLDBException if an error occurs when copying the resource.
     */
    void copyResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName, String preserveType) throws XMLDBException;

    /**
     * Copy a Collection.
     *
     * @param collection the source collection.
     * @param destination the destination collection.
     * @param newName the new name in the destination collection.
     *
     * @throws XMLDBException if an error occurs when copying the resource.
     *
     * @deprecated Use {@link #copy(XmldbURI, XmldbURI, XmldbURI, String)}
     */
    @Deprecated
    void copy(XmldbURI collection, XmldbURI destination, XmldbURI newName) throws XMLDBException;

    /** Copy a Collection
     *
     * @param collection The source collection
     * @param destination The destination collection
     * @param newName The new name of the copied source in the destination collection
     * @param preserveType one of either "DEFAULT", "NO_PRESERVE", "PRESERVE"
     *
     * @throws XMLDBException if an error occurs when copying the resource.
     */
    void copy(XmldbURI collection, XmldbURI destination, XmldbURI newName, String preserveType) throws XMLDBException;

    Collection createCollection(XmldbURI collName, Date created) throws XMLDBException;

    /**
     * Create a Collection.
     *
     * @param collName the collection name.
     *
     * @return the newly created collection.
     *
     * @throws XMLDBException if an error occurs when creating the collection.
     *
     * @deprecated Use XmldbURI version instead
     */
    @Deprecated
    @Override
    Collection createCollection(String collName) throws XMLDBException;

    /**
     * Create a Collection.
     *
     * @param collName the collection name.
     *
     * @return the newly created collection.
     *
     * @throws XMLDBException if an error occurs when creating the collection.
     */
    Collection createCollection(XmldbURI collName) throws XMLDBException;

    /**
     * Remove a Collection.
     *
     * @param collName the name of the collection.
     *
     * @throws XMLDBException if an error occurs when removing the collection.
     *
     * @deprecated Use XmldbURI version instead
     */
    @Override
    @Deprecated
    void removeCollection(String collName) throws XMLDBException;

    void removeCollection(XmldbURI collName) throws XMLDBException;

    void runCommand(String[] params) throws XMLDBException;
}