| PortletConstants.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.model;
24
25 /**
26 * <a href="PortletConstants.java.html"><b><i>View Source</i></b></a>
27 *
28 * @author Brian Wing Shun Chan
29 *
30 */
31 public class PortletConstants {
32
33 /**
34 * War file separator.
35 */
36 public static final String WAR_SEPARATOR = "_WAR_";
37
38 /**
39 * Instance separator.
40 */
41 public static final String INSTANCE_SEPARATOR = "_INSTANCE_";
42
43 /**
44 * Layout separator.
45 */
46 public static final String LAYOUT_SEPARATOR = "_LAYOUT_";
47
48 /**
49 * Default preferences.
50 */
51 public static final String DEFAULT_PREFERENCES = "<portlet-preferences />";
52
53 /**
54 * User principal strategy for screen name.
55 */
56 public static final String USER_PRINCIPAL_STRATEGY_SCREEN_NAME =
57 "screenName";
58
59 /**
60 * User principal strategy for screen name.
61 */
62 public static final String USER_PRINCIPAL_STRATEGY_USER_ID = "userId";
63
64 /**
65 * Facebook integration method for FBML.
66 */
67 public static final String FACEBOOK_INTEGRATION_FBML = "fbml";
68
69 /**
70 * Facebook integration method for IFrame.
71 */
72 public static final String FACEBOOK_INTEGRATION_IFRAME = "iframe";
73
74 /**
75 * Gets the root portlet id of the portlet.
76 *
77 * @param portletId the portlet id of the portlet
78 * @return the root portlet id of the portlet
79 */
80 public static String getRootPortletId(String portletId) {
81 int pos = portletId.indexOf(INSTANCE_SEPARATOR);
82
83 if (pos == -1) {
84 return portletId;
85 }
86 else {
87 return portletId.substring(0, pos);
88 }
89 }
90
91 /**
92 * Gets the instance id of the portlet.
93 *
94 * @param portletId the portlet id of the portlet
95 * @return the instance id of the portlet
96 */
97 public static String getInstanceId(String portletId) {
98 int pos = portletId.indexOf(INSTANCE_SEPARATOR);
99
100 if (pos == -1) {
101 return null;
102 }
103 else {
104 return portletId.substring(
105 pos + INSTANCE_SEPARATOR.length(), portletId.length());
106 }
107 }
108
109 }