1 /**
2 * This file Copyright (c) 2003-2018 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 java.io.InputStream;
39
40 import javax.jcr.Repository;
41 import javax.jcr.RepositoryException;
42 import javax.jcr.Session;
43 import javax.jcr.Workspace;
44
45
46 /**
47 * Repository provider. This interface is intended to be implemented by all repository implementations that can be used by Magnolia.
48 */
49 public interface Provider {
50
51 /**
52 * Initializes repository, this depends on the underlying repository implementation. Use any available method to get
53 * the instance of Repository.
54 *
55 * @param repositoryDefinition key value pars as define in repository.xml
56 */
57 void init(RepositoryDefinition repositoryDefinition) throws RepositoryNotInitializedException;
58
59 /**
60 * Gets the repository instance initialized on init() call.
61 *
62 * @throws RepositoryNotInitializedException if init failed to get repository
63 */
64 Repository getUnderlyingRepository() throws RepositoryNotInitializedException;
65
66 /**
67 * Register namespace with the repository. Refer JCR-170 specifications.
68 *
69 * @param prefix namespace prefix
70 * @param uri namespace URI
71 * @param workspace session workspace instance
72 */
73 void registerNamespace(String prefix, String uri, Workspace workspace) throws RepositoryException;
74
75 /**
76 * Unregister namespace with the repository.
77 *
78 * @param prefix as registered previously
79 * @param workspace session workspace instance
80 */
81 void unregisterNamespace(String prefix, Workspace workspace) throws RepositoryException;
82
83 /**
84 * Node type registration is entirely dependent on the implementation. Refer JSR-170 specifications.
85 */
86 void registerNodeTypes() throws RepositoryException;
87
88 /**
89 * Node type registration is entirely dependent on the implementation. Refer JSR-170 specifications.
90 */
91 void registerNodeTypes(String configuration) throws RepositoryException;
92
93 /**
94 * Node type registration is entirely dependent on the implementation. Refer JSR-170 specifications.
95 *
96 * @param stream , stream type depends on the implementation of this method
97 * @deprecated since 6.1, use {@link #registerNodeTypes(String)} instead.
98 */
99 @Deprecated
100 void registerNodeTypes(InputStream stream) throws RepositoryException;
101
102 /**
103 * Register a new workspace in the current repository.
104 *
105 * @param workspaceName workspace name
106 * @return <code>true</code> true if the workspace is registered now of <code>false</code> if it was already
107 * registered
108 * @throws RepositoryException if any exception occours during registration
109 */
110 boolean registerWorkspace(String workspaceName) throws RepositoryException;
111
112 void shutdownRepository();
113
114 Session getSystemSession(String workspaceName) throws RepositoryException;
115 }