1 /**
2 * This file Copyright (c) 2003-2015 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.context;
35
36 import info.magnolia.cms.core.HierarchyManager;
37 import info.magnolia.cms.core.search.QueryManager;
38 import info.magnolia.cms.i18n.Messages;
39 import info.magnolia.cms.security.AccessManager;
40 import info.magnolia.cms.security.User;
41
42 import java.util.Locale;
43 import java.util.Map;
44
45 import javax.jcr.LoginException;
46 import javax.jcr.RepositoryException;
47 import javax.jcr.Session;
48 import javax.security.auth.Subject;
49
50
51 /**
52 * This interface defines all the methods which should be implemented by any configured magnolia context. Implementing
53 * class should never be accessible directly but only via MgnlContext static methods which work on a local (Thread) copy
54 * of the implementation.
55 */
56 public interface Context extends info.magnolia.commands.chain.Context {
57
58 /**
59 * Attribute visibility scope.
60 */
61 public static final int LOCAL_SCOPE = 1;
62
63 /**
64 * Attribute visibility scope Shared by all requests from this session.
65 */
66 public static final int SESSION_SCOPE = 2;
67
68 /**
69 * Attribute visibility scope, its visible to all sessions of this application.
70 */
71 public static final int APPLICATION_SCOPE = 3;
72
73 final static public String ATTRIBUTE_REPOSITORY = "repository";
74
75 final static public String ATTRIBUTE_PATH = "path";
76
77 final static public String ATTRIBUTE_VERSION = "version";
78
79 final static public String ATTRIBUTE_VERSION_MAP = "versionMap";
80
81 final static public String ATTRIBUTE_UUID = "uuid";
82
83 final static public String ATTRIBUTE_RECURSIVE = "recursive";
84
85 public static final String ATTRIBUTE_COMMENT = "comment";
86
87 public static final String ATTRIBUTE_MESSAGE = "msg";
88
89 public static final String ATTRIBUTE_EXCEPTION = "exception";
90
91 /**
92 * Name of the attribute keeping the user that has launched the command.
93 */
94 public static final String ATTRIBUTE_REQUESTOR = "requestor";
95
96 /**
97 * If this is not a UserContext this method will very likely return the system user.
98 */
99 public User getUser();
100
101 public Subject getSubject();
102
103 public void setLocale(Locale locale);
104
105 /**
106 * Get the current locale.
107 */
108 public Locale getLocale();
109
110 public Session getJCRSession(String workspaceName) throws LoginException, RepositoryException;
111
112 /**
113 * Get hierarchy manager initialized for this user.
114 *
115 * @return hierarchy manager
116 * @deprecated since 4.5 - use {@link #getJCRSession(String)}
117 */
118 @Deprecated
119 public HierarchyManager getHierarchyManager(String workspaceName);
120
121 /**
122 * Get a an {@link info.magnolia.cms.security.AccessManager} for logical entities. The accesses to the repository are handled by the repository itself.
123 */
124 public AccessManager getAccessManager(String name);
125
126 /**
127 * Get QueryManager created for this user on the specified repository.
128 *
129 * @deprecated since 4.5 - use {@link #getJCRSession(String)} and acquire the JCR query manager directly from the session.
130 */
131 @Deprecated
132 public QueryManager getQueryManager(String workspaceName);
133
134 /**
135 * Set attribute value, scope of the attribute is defined.
136 *
137 * @param name is used as a key
138 * @param scope , highest level of scope from which this attribute is visible
139 */
140 public void setAttribute(String name, Object value, int scope);
141
142 /**
143 * Get attribute value.
144 *
145 * @param name to which value is associated to
146 * @param scope the scope (request, session, application)
147 * @return attribute value
148 */
149 public <T> T getAttribute(String name, int scope);
150
151 /**
152 * Get attribute value without passing a scope. the scopes are searched from bottom up (request, session,
153 * application)
154 *
155 * @param name to which value is associated to
156 * @return attribute value
157 */
158 public <T> T getAttribute(String name);
159
160 /**
161 * Get a map of a attributes set in the scope.
162 *
163 * @return the map
164 */
165 public Map<String, Object> getAttributes(int scope);
166
167 /**
168 * Remove an attribute.
169 */
170 public void removeAttribute(String name, int scope);
171
172 /**
173 * Get an over all map.
174 *
175 * @return the map
176 */
177 public Map<String, Object> getAttributes();
178
179 /**
180 * Get the default messages. It uses the locale set on this context
181 * TODO: This duplicates methods from MessagesManager : remove either
182 */
183 public Messages getMessages();
184
185 /**
186 * Get the messages of the named bundle. It uses the locale set on this context
187 *
188 * @param basename name of the bundle
189 * TODO: This duplicates methods from MessagesManager : remove either
190 */
191 public Messages getMessages(String basename);
192
193 /**
194 * Release any resource used by this Context (e.g. jcr sessions).
195 */
196 public void release();
197
198 }