001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.util;
016    
017    import com.liferay.portal.kernel.resiliency.spi.agent.annotation.Direction;
018    import com.liferay.portal.kernel.resiliency.spi.agent.annotation.Distributed;
019    
020    /**
021     * @author Brian Wing Shun Chan
022     */
023    public interface WebKeys {
024    
025            public static final String ASSET_ADDON_ENTRIES = "ASSET_ADDON_ENTRIES";
026    
027            public static final String ASSET_ADDON_ENTRY = "ASSET_ADDON_ENTRY";
028    
029            public static final String ASSET_ENTRY_ABSTRACT_LENGTH = "ASSET_ENTRY_ABSTRACT_LENGTH";
030    
031            public static final String ASSET_ENTRY_VIEW_URL = "ASSET_ENTRY_VIEW_URL";
032    
033            public static final String ASSET_RENDERER = "ASSET_RENDERER";
034    
035            public static final String ASSET_RENDERER_FACTORY = "ASSET_RENDERER_FACTORY";
036    
037            public static final String ASSET_RENDERER_FACTORY_CLASS_TYPE_ID = "ASSET_RENDERER_FACTORY_CLASS_TYPE_ID";
038    
039            @Distributed(direction = Direction.RESPONSE)
040            public static final String AUI_SCRIPT_DATA = "LIFERAY_SHARED_AUI_SCRIPT_DATA";
041    
042            public static final String AUTHENTICATION_TOKEN = "LIFERAY_SHARED_AUTHENTICATION_TOKEN";
043    
044            public static final String BROWSER_SNIFFER_REVISION = "BROWSER_SNIFFER_REVISION";
045    
046            public static final String BROWSER_SNIFFER_VERSION = "BROWSER_SNIFFER_VERSION";
047    
048            public static final String CLP_MESSAGE_LISTENERS = "CLP_MESSAGE_LISTENERS";
049    
050            public static final String CTX = "CTX";
051    
052            public static final String CTX_PATH = "CTX_PATH";
053    
054            public static final String CURRENT_COMPLETE_URL = "CURRENT_COMPLETE_URL";
055    
056            public static final String CURRENT_PORTLET_URL = "CURRENT_PORTLET_URL";
057    
058            @Distributed(direction = Direction.REQUEST)
059            public static final String CURRENT_URL = "CURRENT_URL";
060    
061            public static final String DIFF_HTML_RESULTS = "DIFF_HTML_RESULTS";
062    
063            public static final String DOCUMENT_LIBRARY_FOLDER = "DOCUMENT_LIBRARY_FOLDER";
064    
065            public static final String EXTEND_SESSION = "EXTEND_SESSION";
066    
067            public static final String FACEBOOK_INCOMPLETE_USER_ID = "FACEBOOK_INCOMPLETE_USER_ID";
068    
069            public static final String FACEBOOK_USER_EMAIL_ADDRESS = "FACEBOOK_USER_EMAIL_ADDRESS";
070    
071            public static final String FILE_ITEM_THRESHOLD_SIZE_EXCEEDED = "FILE_ITEM_THRESHOLD_SIZE_EXCEEDED";
072    
073            public static final String FORGOT_PASSWORD_REMINDER_ATTEMPTS = "FORGOT_PASSWORD_REMINDER_ATTEMPTS";
074    
075            public static final String FORGOT_PASSWORD_REMINDER_USER = "FORGOT_PASSWORD_REMINDER_USER";
076    
077            public static final String FORGOT_PASSWORD_REMINDER_USER_EMAIL_ADDRESS = "FORGOT_PASSWORD_REMINDER_USER_EMAIL_ADDRESS";
078    
079            public static final String GROUP = "GROUP";
080    
081            public static final String INVOKER_FILTER_URI = "INVOKER_FILTER_URI";
082    
083            public static final String JAVASCRIPT_CONTEXT = "JAVASCRIPT_CONTEXT";
084    
085            public static final String JOURNAL_ARTICLE = "JOURNAL_ARTICLE";
086    
087            public static final String JOURNAL_ARTICLE_DISPLAY = "JOURNAL_ARTICLE_DISPLAY";
088    
089            public static final String LAST_PATH = "LAST_PATH";
090    
091            public static final String LAYOUT = "LAYOUT";
092    
093            @Distributed
094            public static final String LAYOUT_ASSET_ENTRY = "LIFERAY_SHARED_LAYOUT_ASSET_ENTRY";
095    
096            public static final String LAYOUT_CONTENT = "LAYOUT_CONTENT";
097    
098            public static final String LAYOUTS = "LAYOUTS";
099    
100            /**
101             * @deprecated As of 6.1.0, replaced by {@link #VISITED_GROUP_ID_PREVIOUS}
102             */
103            @Deprecated
104            public static final String LIFERAY_SHARED_VISITED_GROUP_ID_PREVIOUS = "LIFERAY_SHARED_VISITED_GROUP_ID_PREVIOUS";
105    
106            /**
107             * @deprecated As of 6.1.0, replaced by {@link #VISITED_GROUP_ID_RECENT}
108             */
109            @Deprecated
110            public static final String LIFERAY_SHARED_VISITED_GROUP_ID_RECENT = "LIFERAY_SHARED_VISITED_GROUP_ID_RECENT";
111    
112            public static final String OPEN_ID_LOGIN = "OPEN_ID_LOGIN";
113    
114            public static final String OPEN_ID_LOGIN_PENDING = "OPEN_ID_LOGIN_PENDING";
115    
116            public static final String OSGI_BUNDLE = "OSGI_BUNDLE";
117    
118            @Distributed(direction = Direction.RESPONSE)
119            public static final String OUTPUT_DATA = "LIFERAY_SHARED_OUTPUT_DATA";
120    
121            public static final String PAGE_BODY_BOTTOM = "PAGE_BODY_BOTTOM";
122    
123            public static final String PAGE_BODY_TOP = "PAGE_BODY_TOP";
124    
125            public static final String PAGE_BOTTOM = "PAGE_BOTTOM";
126    
127            @Distributed(direction = Direction.RESPONSE)
128            public static final String PAGE_DESCRIPTION = "LIFERAY_SHARED_PAGE_DESCRIPTION";
129    
130            @Distributed(direction = Direction.RESPONSE)
131            public static final String PAGE_KEYWORDS = "LIFERAY_SHARED_PAGE_KEYWORDS";
132    
133            @Distributed(direction = Direction.RESPONSE)
134            public static final String PAGE_SUBTITLE = "LIFERAY_SHARED_PAGE_SUBTITLE";
135    
136            @Distributed(direction = Direction.RESPONSE)
137            public static final String PAGE_TITLE = "LIFERAY_SHARED_PAGE_TITLE";
138    
139            public static final String PAGE_TOP = "PAGE_TOP";
140    
141            public static final String PARALLEL_RENDERING_MERGE_LOCK = "PARALLEL_RENDERING_MERGE_LOCK";
142    
143            public static final String PARALLEL_RENDERING_TIMEOUT_ERROR = "PARALLEL_RENDERING_TIMEOUT_ERROR";
144    
145            public static final String PLUGIN_LAYOUT_TEMPLATES = "PLUGIN_LAYOUT_TEMPLATES";
146    
147            public static final String PLUGIN_PORTLETS = "PLUGIN_PORTLETS";
148    
149            public static final String PLUGIN_REPOSITORY_REPORT = "PLUGIN_REPOSITORY_REPORT";
150    
151            public static final String PLUGIN_THEMES = "PLUGIN_THEMES";
152    
153            public static final String PORTAL_MESSAGES = "LIFERAY_SHARED_PORTAL_MESSAGES";
154    
155            public static final String PORTLET_BREADCRUMBS = "LIFERAY_SHARED_PORTLET_BREADCRUMBS";
156    
157            public static final String PORTLET_CONFIGURATOR_VISIBILITY = "PORTLET_CONFIGURATOR_VISIBILITY";
158    
159            public static final String PORTLET_DECORATE = "PORTLET_DECORATE";
160    
161            public static final String PORTLET_DISPLAY_TEMPLATE = "PORTLET_DISPLAY_TEMPLATE";
162    
163            public static final String PORTLET_ID = "PORTLET_ID";
164    
165            public static final String PORTLET_PREFERENCES_MAP = "PORTLET_PREFERENCES_MAP";
166    
167            public static final String PORTLET_QUICK_ACCESS_ENTRIES = "LIFERAY_SHARED_PORTLET_QUICK_ACCESS_ENTRIES";
168    
169            public static final String PORTLET_RENDER_PARAMETERS = "PORTLET_RENDER_PARAMETERS_";
170    
171            public static final String PORTLET_RESOURCE_STATIC_URLS = "PORTLET_RESOURCE_STATIC_URLS";
172    
173            public static final String PORTLET_SESSION = "PORTLET_SESSION";
174    
175            public static final String PORTLET_SESSION_ATTRIBUTES = "PORTLET_SESSION_ATTRIBUTES_";
176    
177            public static final String PRIVATE_LAYOUT = "PRIVATE_LAYOUT";
178    
179            public static final String REDIRECT = "REDIRECT";
180    
181            public static final String REFERER = "referer";
182    
183            public static final String RENDER_PATH = "RENDER_PATH";
184    
185            public static final String RENDER_PORTLET = "RENDER_PORTLET";
186    
187            public static final String RENDER_PORTLET_BOUNDARY = "RENDER_PORTLET_BOUNDARY";
188    
189            public static final String RENDER_PORTLET_COLUMN_COUNT = "RENDER_PORTLET_COLUMN_COUNT";
190    
191            public static final String RENDER_PORTLET_COLUMN_ID = "RENDER_PORTLET_COLUMN_ID";
192    
193            public static final String RENDER_PORTLET_COLUMN_POS = "RENDER_PORTLET_COLUMN_POS";
194    
195            public static final String RENDER_PORTLET_PREFERENCES = "RENDER_PORTLET_PREFERENCES";
196    
197            public static final String RENDER_PORTLET_RESOURCE = "RENDER_PORTLET_RESOURCE";
198    
199            public static final String SEARCH_CONTAINER = "SEARCH_CONTAINER";
200    
201            public static final String SEARCH_CONTAINER_REFERENCE = "LIFERAY_SHARED_SEARCH_CONTAINER_REFERENCE";
202    
203            public static final String SEARCH_CONTAINER_RESULT_ROW = "SEARCH_CONTAINER_RESULT_ROW";
204    
205            public static final String SEARCH_CONTAINER_RESULT_ROW_CHECKER = "SEARCH_CONTAINER_RESULT_ROW_CHECKER";
206    
207            public static final String SEARCH_CONTAINER_RESULT_ROW_ENTRY = "SEARCH_CONTAINER_RESULT_ROW_ENTRY";
208    
209            public static final String SEARCH_ENTRY_HREF = "SEARCH_ENTRY_HREF";
210    
211            public static final String SEARCH_SEARCH_RESULTS = "SEARCH_SEARCH_RESULTS";
212    
213            public static final String SERVLET_CONTEXT_INCLUDE_FILTER_PATH = "SERVLET_CONTEXT_INCLUDE_FILTER_PATH";
214    
215            public static final String SERVLET_CONTEXT_INCLUDE_FILTER_STRICT = "SERVLET_CONTEXT_INCLUDE_FILTER_STRICT";
216    
217            public static final String SERVLET_CONTEXT_INCLUDE_FILTER_THEME = "SERVLET_CONTEXT_INCLUDE_FILTER_THEME";
218    
219            public static final String SERVLET_PATH = "SERVLET_PATH";
220    
221            public static final String SETTINGS_SCOPE = "SETTINGS_SCOPE";
222    
223            public static final String SINGLE_PAGE_APPLICATION_CLEAR_CACHE = "SINGLE_PAGE_APPLICATION_CLEAR_CACHE";
224    
225            public static final String SINGLE_PAGE_APPLICATION_LAST_PORTLET_ID = "SINGLE_PAGE_APPLICATION_LAST_PORTLET_ID";
226    
227            public static final String SOURCE_VERSION = "SOURCE_VERSION";
228    
229            @Distributed(direction = Direction.RESPONSE)
230            public static final String SPI_AGENT_ACTION_RESULT = "SPI_AGENT_ACTION_RESULT";
231    
232            @Distributed(direction = Direction.REQUEST)
233            public static final String SPI_AGENT_EVENT = "SPI_AGENT_EVENT";
234    
235            @Distributed(direction = Direction.RESPONSE)
236            public static final String SPI_AGENT_EVENT_RESULT = "SPI_AGENT_EVENT_RESULT";
237    
238            @Distributed(direction = Direction.REQUEST)
239            public static final String SPI_AGENT_LAYOUT = "SPI_AGENT_LAYOUT";
240    
241            @Distributed(direction = Direction.RESPONSE)
242            public static final String SPI_AGENT_LAYOUT_TYPE_SETTINGS = "SPI_AGENT_LAYOUT_TYPE_SETTINGS";
243    
244            @Distributed(direction = Direction.REQUEST)
245            public static final String SPI_AGENT_LIFECYCLE = "SPI_AGENT_LIFECYCLE";
246    
247            public static final String SPI_AGENT_ORIGINAL_RESPONSE = "SPI_AGENT_ORIGINAL_RESPONSE";
248    
249            @Distributed(direction = Direction.REQUEST)
250            public static final String SPI_AGENT_PORTLET = "SPI_AGENT_PORTLET";
251    
252            public static final String SPI_AGENT_REQUEST = "SPI_AGENT_REQUEST";
253    
254            public static final String SPI_AGENT_RESPONSE = "SPI_AGENT_RESPONSE";
255    
256            public static final String TARGET_VERSION = "TARGET_VERSION";
257    
258            public static final String THEME = "THEME";
259    
260            public static final String THEME_DISPLAY = "LIFERAY_SHARED_THEME_DISPLAY";
261    
262            public static final String TITLE = "TITLE";
263    
264            public static final String UNIQUE_ELEMENT_IDS = "LIFERAY_SHARED_UNIQUE_ELEMENT_IDS";
265    
266            public static final String UPLOAD_EXCEPTION = "UPLOAD_EXCEPTION";
267    
268            @Distributed(direction = Direction.REQUEST)
269            public static final String USER = "USER";
270    
271            @Distributed(direction = Direction.REQUEST)
272            public static final String USER_ID = "USER_ID";
273    
274            public static final String USER_PASSWORD = "USER_PASSWORD";
275    
276            public static final String USER_UUID = "USER_UUID";
277    
278            public static final String VISITED_GROUP_ID_PREVIOUS = "LIFERAY_SHARED_VISITED_GROUP_ID_PREVIOUS";
279    
280            public static final String VISITED_GROUP_ID_RECENT = "LIFERAY_SHARED_VISITED_GROUP_ID_RECENT";
281    
282            public static final String VM_VARIABLES = "VM_VARIABLES";
283    
284            public static final String WINDOW_STATE = "WINDOW_STATE";
285    
286            public static final String WORKFLOW_ASSET_PREVIEW = "WORKFLOW_ASSET_PREVIEW";
287    
288            public static final String XUGGLER_INSTALL_STATUS = "XUGGLER_INSTALL_STATUS";
289    
290    }