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