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_RENDERER = "ASSET_RENDERER";
026    
027            public static final String ASSET_RENDERER_FACTORY = "ASSET_RENDERER_FACTORY";
028    
029            public static final String ASSET_RENDERER_FACTORY_CLASS_TYPE_ID = "ASSET_RENDERER_FACTORY_CLASS_TYPE_ID";
030    
031            @Distributed(direction = Direction.RESPONSE)
032            public static final String AUI_SCRIPT_DATA = "LIFERAY_SHARED_AUI_SCRIPT_DATA";
033    
034            public static final String AUTHENTICATION_TOKEN = "LIFERAY_SHARED_AUTHENTICATION_TOKEN";
035    
036            public static final String BROWSER_SNIFFER_REVISION = "BROWSER_SNIFFER_REVISION";
037    
038            public static final String BROWSER_SNIFFER_VERSION = "BROWSER_SNIFFER_VERSION";
039    
040            public static final String CLP_MESSAGE_LISTENERS = "CLP_MESSAGE_LISTENERS";
041    
042            public static final String CTX = "CTX";
043    
044            public static final String CTX_PATH = "CTX_PATH";
045    
046            public static final String CURRENT_COMPLETE_URL = "CURRENT_COMPLETE_URL";
047    
048            public static final String CURRENT_PORTLET_URL = "CURRENT_PORTLET_URL";
049    
050            @Distributed(direction = Direction.REQUEST)
051            public static final String CURRENT_URL = "CURRENT_URL";
052    
053            public static final String DOCUMENT_LIBRARY_FOLDER = "DOCUMENT_LIBRARY_FOLDER";
054    
055            public static final String EXTEND_SESSION = "EXTEND_SESSION";
056    
057            public static final String FILE_ITEM_THRESHOLD_SIZE_EXCEEDED = "FILE_ITEM_THRESHOLD_SIZE_EXCEEDED";
058    
059            public static final String FORGOT_PASSWORD_REMINDER_ATTEMPTS = "FORGOT_PASSWORD_REMINDER_ATTEMPTS";
060    
061            public static final String FORGOT_PASSWORD_REMINDER_USER = "FORGOT_PASSWORD_REMINDER_USER";
062    
063            public static final String FORGOT_PASSWORD_REMINDER_USER_EMAIL_ADDRESS = "FORGOT_PASSWORD_REMINDER_USER_EMAIL_ADDRESS";
064    
065            public static final String GROUP = "GROUP";
066    
067            public static final String INVOKER_FILTER_URI = "INVOKER_FILTER_URI";
068    
069            public static final String JAVASCRIPT_CONTEXT = "JAVASCRIPT_CONTEXT";
070    
071            public static final String JOURNAL_ARTICLE = "JOURNAL_ARTICLE";
072    
073            public static final String JOURNAL_ARTICLE_DISPLAY = "JOURNAL_ARTICLE_DISPLAY";
074    
075            public static final String LAST_PATH = "LAST_PATH";
076    
077            public static final String LAYOUT = "LAYOUT";
078    
079            public static final String LAYOUTS = "LAYOUTS";
080    
081            /**
082             * @deprecated As of 6.1.0, replaced by {@link #VISITED_GROUP_ID_PREVIOUS}
083             */
084            @Deprecated
085            public static final String LIFERAY_SHARED_VISITED_GROUP_ID_PREVIOUS = "LIFERAY_SHARED_VISITED_GROUP_ID_PREVIOUS";
086    
087            /**
088             * @deprecated As of 6.1.0, replaced by {@link #VISITED_GROUP_ID_RECENT}
089             */
090            @Deprecated
091            public static final String LIFERAY_SHARED_VISITED_GROUP_ID_RECENT = "LIFERAY_SHARED_VISITED_GROUP_ID_RECENT";
092    
093            public static final String OSGI_BUNDLE = "OSGI_BUNDLE";
094    
095            @Distributed(direction = Direction.RESPONSE)
096            public static final String OUTPUT_DATA = "LIFERAY_SHARED_OUTPUT_DATA";
097    
098            public static final String PAGE_BODY_BOTTOM = "PAGE_BODY_BOTTOM";
099    
100            public static final String PAGE_BODY_TOP = "PAGE_BODY_TOP";
101    
102            public static final String PAGE_BOTTOM = "PAGE_BOTTOM";
103    
104            @Distributed(direction = Direction.RESPONSE)
105            public static final String PAGE_DESCRIPTION = "LIFERAY_SHARED_PAGE_DESCRIPTION";
106    
107            @Distributed(direction = Direction.RESPONSE)
108            public static final String PAGE_KEYWORDS = "LIFERAY_SHARED_PAGE_KEYWORDS";
109    
110            @Distributed(direction = Direction.RESPONSE)
111            public static final String PAGE_SUBTITLE = "LIFERAY_SHARED_PAGE_SUBTITLE";
112    
113            @Distributed(direction = Direction.RESPONSE)
114            public static final String PAGE_TITLE = "LIFERAY_SHARED_PAGE_TITLE";
115    
116            public static final String PAGE_TOP = "PAGE_TOP";
117    
118            public static final String PARALLEL_RENDERING_MERGE_LOCK = "PARALLEL_RENDERING_MERGE_LOCK";
119    
120            public static final String PARALLEL_RENDERING_TIMEOUT_ERROR = "PARALLEL_RENDERING_TIMEOUT_ERROR";
121    
122            public static final String PLUGIN_LAYOUT_TEMPLATES = "PLUGIN_LAYOUT_TEMPLATES";
123    
124            public static final String PLUGIN_PORTLETS = "PLUGIN_PORTLETS";
125    
126            public static final String PLUGIN_REPOSITORY_REPORT = "PLUGIN_REPOSITORY_REPORT";
127    
128            public static final String PLUGIN_THEMES = "PLUGIN_THEMES";
129    
130            public static final String PORTAL_MESSAGES = "LIFERAY_SHARED_PORTAL_MESSAGES";
131    
132            public static final String PORTLET_BREADCRUMBS = "LIFERAY_SHARED_PORTLET_BREADCRUMBS";
133    
134            public static final String PORTLET_CONFIGURATOR_VISIBILITY = "PORTLET_CONFIGURATOR_VISIBILITY";
135    
136            public static final String PORTLET_DECORATE = "PORTLET_DECORATE";
137    
138            public static final String PORTLET_ID = "PORTLET_ID";
139    
140            public static final String PORTLET_PREFERENCES_MAP = "PORTLET_PREFERENCES_MAP";
141    
142            public static final String PORTLET_QUICK_ACCESS_ENTRIES = "LIFERAY_SHARED_PORTLET_QUICK_ACCESS_ENTRIES";
143    
144            public static final String PORTLET_RESOURCE_STATIC_URLS = "PORTLET_RESOURCE_STATIC_URLS";
145    
146            public static final String PORTLET_SESSION = "PORTLET_SESSION";
147    
148            public static final String PORTLET_SESSION_ATTRIBUTES = "PORTLET_SESSION_ATTRIBUTES_";
149    
150            public static final String REDIRECT = "REDIRECT";
151    
152            public static final String REFERER = "referer";
153    
154            public static final String RENDER_PATH = "RENDER_PATH";
155    
156            public static final String RENDER_PORTLET = "RENDER_PORTLET";
157    
158            public static final String RENDER_PORTLET_BOUNDARY = "RENDER_PORTLET_BOUNDARY";
159    
160            public static final String RENDER_PORTLET_COLUMN_COUNT = "RENDER_PORTLET_COLUMN_COUNT";
161    
162            public static final String RENDER_PORTLET_COLUMN_ID = "RENDER_PORTLET_COLUMN_ID";
163    
164            public static final String RENDER_PORTLET_COLUMN_POS = "RENDER_PORTLET_COLUMN_POS";
165    
166            public static final String RENDER_PORTLET_RESOURCE = "RENDER_PORTLET_RESOURCE";
167    
168            public static final String SEARCH_CONTAINER = "SEARCH_CONTAINER";
169    
170            public static final String SEARCH_CONTAINER_REFERENCE = "LIFERAY_SHARED_SEARCH_CONTAINER_REFERENCE";
171    
172            public static final String SEARCH_CONTAINER_RESULT_ROW = "SEARCH_CONTAINER_RESULT_ROW";
173    
174            public static final String SEARCH_CONTAINER_RESULT_ROW_ENTRY = "SEARCH_CONTAINER_RESULT_ROW_ENTRY";
175    
176            public static final String SEARCH_SEARCH_RESULTS = "SEARCH_SEARCH_RESULTS";
177    
178            public static final String SERVLET_CONTEXT_INCLUDE_FILTER_PATH = "SERVLET_CONTEXT_INCLUDE_FILTER_PATH";
179    
180            public static final String SERVLET_CONTEXT_INCLUDE_FILTER_STRICT = "SERVLET_CONTEXT_INCLUDE_FILTER_STRICT";
181    
182            public static final String SERVLET_CONTEXT_INCLUDE_FILTER_THEME = "SERVLET_CONTEXT_INCLUDE_FILTER_THEME";
183    
184            public static final String SERVLET_PATH = "SERVLET_PATH";
185    
186            public static final String SINGLE_PAGE_APPLICATION_LAST_PORTLET_ID = "SINGLE_PAGE_APPLICATION_LAST_PORTLET_ID";
187    
188            @Distributed(direction = Direction.RESPONSE)
189            public static final String SPI_AGENT_ACTION_RESULT = "SPI_AGENT_ACTION_RESULT";
190    
191            @Distributed(direction = Direction.REQUEST)
192            public static final String SPI_AGENT_EVENT = "SPI_AGENT_EVENT";
193    
194            @Distributed(direction = Direction.RESPONSE)
195            public static final String SPI_AGENT_EVENT_RESULT = "SPI_AGENT_EVENT_RESULT";
196    
197            @Distributed(direction = Direction.REQUEST)
198            public static final String SPI_AGENT_LAYOUT = "SPI_AGENT_LAYOUT";
199    
200            @Distributed(direction = Direction.RESPONSE)
201            public static final String SPI_AGENT_LAYOUT_TYPE_SETTINGS = "SPI_AGENT_LAYOUT_TYPE_SETTINGS";
202    
203            @Distributed(direction = Direction.REQUEST)
204            public static final String SPI_AGENT_LIFECYCLE = "SPI_AGENT_LIFECYCLE";
205    
206            public static final String SPI_AGENT_ORIGINAL_RESPONSE = "SPI_AGENT_ORIGINAL_RESPONSE";
207    
208            @Distributed(direction = Direction.REQUEST)
209            public static final String SPI_AGENT_PORTLET = "SPI_AGENT_PORTLET";
210    
211            public static final String SPI_AGENT_REQUEST = "SPI_AGENT_REQUEST";
212    
213            public static final String SPI_AGENT_RESPONSE = "SPI_AGENT_RESPONSE";
214    
215            public static final String THEME = "THEME";
216    
217            public static final String THEME_DISPLAY = "LIFERAY_SHARED_THEME_DISPLAY";
218    
219            public static final String UNIQUE_ELEMENT_IDS = "LIFERAY_SHARED_UNIQUE_ELEMENT_IDS";
220    
221            public static final String UPLOAD_EXCEPTION = "UPLOAD_EXCEPTION";
222    
223            @Distributed(direction = Direction.REQUEST)
224            public static final String USER = "USER";
225    
226            @Distributed(direction = Direction.REQUEST)
227            public static final String USER_ID = "USER_ID";
228    
229            public static final String USER_PASSWORD = "USER_PASSWORD";
230    
231            public static final String USER_UUID = "USER_UUID";
232    
233            public static final String VISITED_GROUP_ID_PREVIOUS = "LIFERAY_SHARED_VISITED_GROUP_ID_PREVIOUS";
234    
235            public static final String VISITED_GROUP_ID_RECENT = "LIFERAY_SHARED_VISITED_GROUP_ID_RECENT";
236    
237            public static final String VM_VARIABLES = "VM_VARIABLES";
238    
239            public static final String WINDOW_STATE = "WINDOW_STATE";
240    
241            public static final String XUGGLER_INSTALL_STATUS = "XUGGLER_INSTALL_STATUS";
242    
243    }