1 /**
2 * This file Copyright (c) 2003-2011 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 * @author Sameer Charles
56 * @version $Revision $ ($Author $)
57 */
58 public interface Context extends org.apache.commons.chain.Context {
59
60 /**
61 * Attribute visibility scope.
62 */
63 public static final int LOCAL_SCOPE = 1;
64
65 /**
66 * Attribute visibility scope Shared by all requests from this session.
67 */
68 public static final int SESSION_SCOPE = 2;
69
70 /**
71 * Attribute visibility scope, its visible to all sessions of this application.
72 */
73 public static final int APPLICATION_SCOPE = 3;
74
75 final static public String ATTRIBUTE_REPOSITORY = "repository";
76
77 final static public String ATTRIBUTE_PATH = "path";
78
79 final static public String ATTRIBUTE_VERSION = "version";
80
81 final static public String ATTRIBUTE_VERSION_MAP = "versionMap";
82
83 final static public String ATTRIBUTE_UUID = "uuid";
84
85 final static public String ATTRIBUTE_RECURSIVE = "recursive";
86
87 public static final String ATTRIBUTE_COMMENT = "comment";
88
89 public static final String ATTRIBUTE_MESSAGE = "msg";
90
91 public static final String ATTRIBUTE_EXCEPTION = "exception";
92
93 /**
94 * If this is not a UserContext this method will very likely return the system user.
95 */
96 public User getUser();
97
98 public Subject getSubject();
99
100 /**
101 * @param locale
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 * @param workspaceName
115 * @return hierarchy manager
116 *
117 * @deprecated since 4.5 - use {@link #getJCRSession(String)}
118 */
119 @Deprecated
120 public HierarchyManager getHierarchyManager(String workspaceName);
121
122 /**
123 * Get a an {@link info.magnolia.cms.security.AccessManager} for logical entities. The accesses to the repository are handled by the repository itself.
124 */
125 public AccessManager getAccessManager(String name);
126
127 /**
128 * Get QueryManager created for this user on the specified repository.
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 * @param name is used as a key
137 * @param scope , highest level of scope from which this attribute is visible
138 */
139 public void setAttribute(String name, Object value, int scope);
140
141 /**
142 * Get attribute value.
143 * @param name to which value is associated to
144 * @param scope the scope (request, session, application)
145 * @return attribute value
146 */
147 public <T> T getAttribute(String name, int scope);
148
149 /**
150 * Get attribute value without passing a scope. the scopes are searched from bottom up (request, session,
151 * application)
152 * @param name to which value is associated to
153 * @return attribute value
154 */
155 public <T> T getAttribute(String name);
156
157 /**
158 * Get a map of a attributes set in the scope.
159 * @param scope
160 * @return the map
161 */
162 public Map<String, Object> getAttributes(int scope);
163
164 /**
165 * Remove an attribute.
166 * @param name
167 * @param scope
168 */
169 public void removeAttribute(String name, int scope);
170
171 /**
172 * Get an over all map.
173 * @return the map
174 */
175 public Map<String, Object> getAttributes();
176
177 /**
178 * Get the default messages. It uses the locale set on this context
179 * TODO: This duplicates methods from MessagesManager : remove either
180 */
181 public Messages getMessages();
182
183 /**
184 * Get the messages of the named bundle. It uses the locale set on this context
185 * @param basename name of the bundle
186 * TODO: This duplicates methods from MessagesManager : remove either
187 */
188 public Messages getMessages(String basename);
189
190 /**
191 * Release any resource used by this Context (e.g. jcr sessions).
192 */
193 public void release();
194
195 }