Java tutorial
/** * Copyright (c) 2000-present Liferay, Inc. All rights reserved. * * This library is free software; you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation; either version 2.1 of the License, or (at your option) * any later version. * * This library is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. */ package com.liferay.portal.kernel.upgrade; import com.liferay.petra.string.StringBundler; import com.liferay.petra.string.StringPool; import com.liferay.portal.kernel.dao.jdbc.AutoBatchPreparedStatementUtil; import com.liferay.portal.kernel.dao.jdbc.DataAccess; import com.liferay.portal.kernel.util.GetterUtil; import com.liferay.portal.kernel.util.LoggingTimer; import com.liferay.portal.kernel.util.StringUtil; import com.liferay.portal.kernel.util.Validator; import java.sql.PreparedStatement; import java.sql.ResultSet; import javax.portlet.PortletPreferences; import javax.portlet.ReadOnlyException; /** * @author Jorge Ferrer * @author Brian Wing Shun Chan */ public abstract class BaseUpgradePortletPreferences extends UpgradeProcess { @Override protected void doUpgrade() throws Exception { updatePortletPreferences(); } protected long getCompanyId(String sql, long primaryKey) throws Exception { long companyId = 0; PreparedStatement ps = null; ResultSet rs = null; try { ps = connection.prepareStatement(sql); ps.setLong(1, primaryKey); rs = ps.executeQuery(); while (rs.next()) { companyId = rs.getLong("companyId"); } } finally { DataAccess.cleanUp(ps, rs); } return companyId; } protected Object[] getGroup(long groupId) throws Exception { Object[] group = null; PreparedStatement ps = null; ResultSet rs = null; try { ps = connection.prepareStatement("select companyId from Group_ where groupId = ?"); ps.setLong(1, groupId); rs = ps.executeQuery(); while (rs.next()) { long companyId = rs.getLong("companyId"); group = new Object[] { groupId, companyId }; } } finally { DataAccess.cleanUp(ps, rs); } return group; } protected Object[] getLayout(long plid) throws Exception { Object[] layout = null; PreparedStatement ps = null; ResultSet rs = null; try { ps = connection.prepareStatement( "select groupId, companyId, privateLayout, layoutId from " + "Layout where plid = ?"); ps.setLong(1, plid); rs = ps.executeQuery(); while (rs.next()) { long groupId = rs.getLong("groupId"); long companyId = rs.getLong("companyId"); boolean privateLayout = rs.getBoolean("privateLayout"); long layoutId = rs.getLong("layoutId"); layout = new Object[] { groupId, companyId, privateLayout, layoutId }; } } finally { DataAccess.cleanUp(ps, rs); } if (layout == null) { layout = getLayoutRevision(plid); } return layout; } protected Object[] getLayoutRevision(long layoutRevisionId) throws Exception { Object[] layoutRevision = null; PreparedStatement ps = null; ResultSet rs = null; try { ps = connection.prepareStatement("select groupId, companyId, privateLayout, layoutRevisionId " + "from LayoutRevision where layoutRevisionId = ?"); ps.setLong(1, layoutRevisionId); rs = ps.executeQuery(); while (rs.next()) { long groupId = rs.getLong("groupId"); long companyId = rs.getLong("companyId"); boolean privateLayout = rs.getBoolean("privateLayout"); long layoutId = rs.getLong("layoutRevisionId"); layoutRevision = new Object[] { groupId, companyId, privateLayout, layoutId }; } } finally { DataAccess.cleanUp(ps, rs); } return layoutRevision; } protected String getLayoutUuid(long plid, long layoutId) throws Exception { Object[] layout = getLayout(plid); if (layout == null) { return null; } String uuid = null; PreparedStatement ps = null; ResultSet rs = null; try { ps = connection.prepareStatement( "select uuid_ from Layout where groupId = ? and " + "privateLayout = ? and layoutId = ?"); long groupId = (Long) layout[0]; boolean privateLayout = (Boolean) layout[2]; ps.setLong(1, groupId); ps.setBoolean(2, privateLayout); ps.setLong(3, layoutId); rs = ps.executeQuery(); if (rs.next()) { uuid = rs.getString("uuid_"); } } finally { DataAccess.cleanUp(ps, rs); } return uuid; } protected String[] getPortletIds() { return new String[0]; } protected String getUpdatePortletPreferencesWhereClause() { String[] portletIds = getPortletIds(); if (portletIds.length == 0) { throw new IllegalArgumentException( "Subclasses must override getPortletIds or " + "getUpdatePortletPreferencesWhereClause"); } StringBundler sb = new StringBundler(portletIds.length * 5 - 1); for (int i = 0; i < portletIds.length; i++) { String portletId = portletIds[i]; sb.append("PortletPreferences.portletId "); if (portletId.contains(StringPool.PERCENT)) { sb.append(" like '"); sb.append(portletId); sb.append("'"); } else { sb.append(" = '"); sb.append(portletId); sb.append("'"); } if ((i + 1) < portletIds.length) { sb.append(" or "); } } return sb.toString(); } protected void updatePortletPreferences() throws Exception { try (LoggingTimer loggingTimer = new LoggingTimer()) { StringBundler sb = new StringBundler(5); sb.append("select portletPreferencesId, companyId, ownerId, "); sb.append("ownerType, plid, portletId, preferences from "); sb.append("PortletPreferences"); String whereClause = getUpdatePortletPreferencesWhereClause(); if (Validator.isNotNull(whereClause)) { sb.append(" where "); sb.append(whereClause); } try (PreparedStatement ps1 = connection.prepareStatement(sb.toString()); PreparedStatement ps2 = AutoBatchPreparedStatementUtil.concurrentAutoBatch(connection, "update PortletPreferences set preferences = ? where " + "portletPreferencesId = ?"); PreparedStatement ps3 = AutoBatchPreparedStatementUtil.concurrentAutoBatch(connection, "delete from PortletPreferences where " + "portletPreferencesId = ?"); ResultSet rs = ps1.executeQuery()) { while (rs.next()) { long portletPreferencesId = rs.getLong("portletPreferencesId"); long companyId = rs.getLong("companyId"); if (companyId > 0) { int ownerType = rs.getInt("ownerType"); long plid = rs.getLong("plid"); long ownerId = rs.getLong("ownerId"); String portletId = rs.getString("portletId"); String preferences = GetterUtil.getString(rs.getString("preferences")); String newPreferences = upgradePreferences(companyId, ownerId, ownerType, plid, portletId, preferences); if (!preferences.equals(newPreferences)) { ps2.setString(1, newPreferences); ps2.setLong(2, portletPreferencesId); ps2.addBatch(); } } else { ps3.setLong(1, portletPreferencesId); ps3.addBatch(); } } ps2.executeBatch(); ps3.executeBatch(); } } } protected void upgradeMultiValuePreference(PortletPreferences portletPreferences, String key) throws ReadOnlyException { String value = portletPreferences.getValue(key, StringPool.BLANK); if (Validator.isNotNull(value)) { portletPreferences.setValues(key, StringUtil.split(value)); } } protected abstract String upgradePreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) throws Exception; }