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.cms.core;
35
36 import info.magnolia.cms.core.search.QueryManager;
37 import info.magnolia.cms.security.AccessDeniedException;
38 import info.magnolia.cms.security.AccessManager;
39
40 import javax.jcr.RepositoryException;
41 import javax.jcr.Workspace;
42
43 /**
44 * Main class to access content. Is retrieved by {@link MgnlContext#getHierarchyManager(String)}.
45 * The {@link DefaultHierarchyManager} wraps a JCR session.
46 *
47 * @author gjoseph
48 * @version $Revision: 36516 $ ($Author: pbaerfuss $)
49 */
50 public interface HierarchyManager {
51
52 AccessManager getAccessManager();
53
54 QueryManager getQueryManager();
55
56 Content createContent(String path, String label, String contentType) throws RepositoryException;
57
58 Content getContent(String path) throws RepositoryException;
59
60 Content getContent(String path, boolean create, ItemType type) throws RepositoryException;
61
62 NodeData getNodeData(String path) throws RepositoryException;
63
64 /**
65 * @deprecated since 4.0 - only used by taglibs - should go/move.
66 */
67 Content getPage(String path, String templateName) throws RepositoryException;
68
69 void delete(String path) throws RepositoryException;
70
71 Content getRoot() throws RepositoryException;
72
73 /**
74 * @deprecated since 4.0 - use getContent().isNodeType() instead.
75 */
76 boolean isPage(String path) throws AccessDeniedException;
77
78 boolean isExist(String path);
79
80 /**
81 * Checks for the allowed access rights.
82 * @param permissions permission mask
83 * @param path path to content to be checked
84 * @return true if the current user has access on the provided node path.
85 */
86 boolean isGranted(String path, long permissions);
87
88 /**
89 * @deprecated since 4.0 - use getContent().isNodeType() instead. (not used currently)
90 */
91 boolean isNodeType(String path, String type);
92
93 /**
94 * @deprecated since 4.0 - use getContent().isNodeType() instead. (not used currently)
95 */
96 boolean isNodeType(String path, ItemType type);
97
98 boolean isNodeData(String path) throws AccessDeniedException;
99
100 Content getContentByUUID(String uuid) throws RepositoryException;
101
102 Workspace getWorkspace();
103
104 void moveTo(String source, String destination) throws RepositoryException;
105
106 void copyTo(String source, String destination) throws RepositoryException;
107
108 void save() throws RepositoryException;
109
110 boolean hasPendingChanges() throws RepositoryException;
111
112 void refresh(boolean keepChanges) throws RepositoryException;
113
114 String getName();
115 }