PortletConstants.java |
1 /** 2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved. 3 * 4 * 5 * 6 * 7 * The contents of this file are subject to the terms of the Liferay Enterprise 8 * Subscription License ("License"). You may not use this file except in 9 * compliance with the License. You can obtain a copy of the License by 10 * contacting Liferay, Inc. See the License for the specific language governing 11 * permissions and limitations under the License, including but not limited to 12 * distribution rights 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 public class PortletConstants { 31 32 /** 33 * War file separator. 34 */ 35 public static final String WAR_SEPARATOR = "_WAR_"; 36 37 /** 38 * Instance separator. 39 */ 40 public static final String INSTANCE_SEPARATOR = "_INSTANCE_"; 41 42 /** 43 * Layout separator. 44 */ 45 public static final String LAYOUT_SEPARATOR = "_LAYOUT_"; 46 47 /** 48 * Default preferences. 49 */ 50 public static final String DEFAULT_PREFERENCES = "<portlet-preferences />"; 51 52 /** 53 * User principal strategy for screen name. 54 */ 55 public static final String USER_PRINCIPAL_STRATEGY_SCREEN_NAME = 56 "screenName"; 57 58 /** 59 * User principal strategy for screen name. 60 */ 61 public static final String USER_PRINCIPAL_STRATEGY_USER_ID = "userId"; 62 63 /** 64 * Facebook integration method for FBML. 65 */ 66 public static final String FACEBOOK_INTEGRATION_FBML = "fbml"; 67 68 /** 69 * Facebook integration method for IFrame. 70 */ 71 public static final String FACEBOOK_INTEGRATION_IFRAME = "iframe"; 72 73 /** 74 * Gets the root portlet id of the portlet. 75 * 76 * @return the root portlet id of the portlet 77 */ 78 public static String getRootPortletId(String portletId) { 79 int pos = portletId.indexOf(INSTANCE_SEPARATOR); 80 81 if (pos == -1) { 82 return portletId; 83 } 84 else { 85 return portletId.substring(0, pos); 86 } 87 } 88 89 /** 90 * Gets the instance id of the portlet. 91 * 92 * @return the instance id of the portlet 93 */ 94 public static String getInstanceId(String portletId) { 95 int pos = portletId.indexOf(INSTANCE_SEPARATOR); 96 97 if (pos == -1) { 98 return null; 99 } 100 else { 101 return portletId.substring( 102 pos + INSTANCE_SEPARATOR.length(), portletId.length()); 103 } 104 } 105 106 }