1 /**
2 * This file Copyright (c) 2003-2014 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.repository;
35
36 import info.magnolia.repository.definition.RepositoryDefinition;
37
38 import javax.jcr.Repository;
39 import javax.jcr.RepositoryException;
40 import javax.jcr.Session;
41 import javax.jcr.Workspace;
42 import java.io.InputStream;
43
44
45 /**
46 * Repository provider. This interface is intended to be implemented by all repository implementations that can be used by Magnolia.
47 * @author Sameer Charles
48 * @author Fabrizio Giustina
49 * @version $Id$
50 */
51 public interface Provider {
52
53 /**
54 * Initializes repository, this depends on the underlying repository implementation. Use any available method to get
55 * the instance of Repository.
56 * @param repositoryDefinition key value pars as define in repository.xml
57 * @throws RepositoryNotInitializedException
58 */
59 void init(RepositoryDefinition repositoryDefinition) throws RepositoryNotInitializedException;
60
61 /**
62 * Gets the repository instance initialized on init() call.
63 * @throws RepositoryNotInitializedException if init failed to get repository
64 */
65 Repository getUnderlyingRepository() throws RepositoryNotInitializedException;
66
67 /**
68 * @deprecated since 4.0 - typo - use get #getUnderlyingRepository() instead
69 */
70 Repository getUnderlineRepository() throws RepositoryNotInitializedException;
71
72 /**
73 * Register namespace with the repository. Refer JCR-170 specifications.
74 * @param prefix namespace prefix
75 * @param uri namespace URI
76 * @param workspace session workspace instance
77 * @throws RepositoryException
78 */
79 void registerNamespace(String prefix, String uri, Workspace workspace) throws RepositoryException;
80
81 /**
82 * Unregister namespace with the repository.
83 * @param prefix as registered previously
84 * @param workspace session workspace instance
85 * @throws RepositoryException
86 */
87 void unregisterNamespace(String prefix, Workspace workspace) throws RepositoryException;
88
89 /**
90 * Node type registration is entirely dependent on the implementation. Refer JSR-170 specifications.
91 * @throws RepositoryException
92 */
93 void registerNodeTypes() throws RepositoryException;
94
95 /**
96 * Node type registration is entirely dependent on the implementation. Refer JSR-170 specifications.
97 * @throws RepositoryException
98 */
99 void registerNodeTypes(String configuration) throws RepositoryException;
100
101 /**
102 * Node type registration is entirely dependent on the implementation. Refer JSR-170 specifications.
103 * @param stream , stream type depends on the implementation of this method
104 * @throws RepositoryException
105 */
106 void registerNodeTypes(InputStream stream) throws RepositoryException;
107
108 /**
109 * Register a new workspace in the current repository.
110 * @param workspaceName workspace name
111 * @return <code>true</code> true if the workspace is registered now of <code>false</code> if it was already
112 * registered
113 * @throws RepositoryException if any exception occours during registration
114 */
115 boolean registerWorkspace(String workspaceName) throws RepositoryException;
116
117 void shutdownRepository();
118
119 Session getSystemSession(String workspaceName) throws RepositoryException;
120 }