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