atom.content.JcrManager Maven / Gradle / Ivy
/*
* Copyright © 2013 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.content;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
* Java Content Repository Manager corresponded for all operations that used for
* interaction with repository.
*
* @author Alex Voloshyn
* @version 1.2 11/1/13
*/
public interface JcrManager {
/**
* Equivalent to login(null, workspaceName).
*
* @param workspace the name of a workspace
* @return a valid session for the user to access the repository
* @throws javax.jcr.RepositoryException if authentication or authorization
* for the specified workspace fails
* or another error occurs
*/
Session login(String workspace) throws RepositoryException;
/**
* Deserializes an XML document and adds the resulting item sub-graph as a
* child of the node at root node.
*
* If the incoming XML stream does not appear to be a JCR system view
* XML document then it is interpreted as a document view XML
* document.
*
* The passed InputStream is closed before this method returns
* either normally or because of an exception.
*
* @param workspace the name of a workspace
* @param stream the InputStream from which the XML to be
* deserialized is read
* @throws IOException if an error during an I/O operation occurs
* @throws RepositoryException if another error occurs
*/
void importXML(String workspace, InputStream stream)
throws RepositoryException, IOException;
/**
* The serialized output will reflect the state of the current workspace as
* modified by the state of this Session. This means that
* pending changes (regardless of whether they are valid according to node
* type constraints) and all namespace mappings in the namespace registry,
* as modified by the current session-mappings, are reflected in the
* output.
*
* The output XML will be encoded in UTF-8.
*
* @param workspace the name of a workspace
* @param stream the OutputStream to which the XML
* serialization of the subgraph will be output
* @throws IOException if an error during an I/O operation occurs
* @throws RepositoryException if another error occurs
*/
void exportXML(String workspace, OutputStream stream)
throws RepositoryException, IOException;
/**
* Deserializes an XML document and adds the resulting item sub-graph as a
* child of the node at root node.
*
* Content imported only in case when repository is empty (root node
* contains only jcr:system folder).
*
* @param workspace the name of a workspace
* @param stream the InputStream from which the XML to be
* deserialized is read
* @throws IOException if an error during an I/O operation occurs
* @throws RepositoryException if another error occurs
*/
void initialContent(String workspace, InputStream stream)
throws RepositoryException, IOException;
/**
* Registers or updates the node type definitions per the Compact Node
* Definition (CND) file given by the supplied stream. This method is used
* to register or update a set of node types with mutual dependencies.
* Returns an iterator over the resulting NodeType objects.
*
* The effect of the method is "all or nothing"; if an error occurs, no node
* types are registered or updated.
*
* @param stream the stream containing the node type definitions in CND
* format
* @throws IOException if an error during an I/O operation occurs
* @throws RepositoryException if another error occurs
*/
void registerNodeTypes(InputStream stream)
throws RepositoryException, IOException;
}