com.liferay.exportimport.kernel.lar

Class DefaultConfigurationPortletDataHandler

java.lang.Object

com.liferay.exportimport.kernel.lar.BasePortletDataHandler

com.liferay.exportimport.kernel.lar.DefaultConfigurationPortletDataHandler

All Implemented Interfaces:

PortletDataHandler

public class DefaultConfigurationPortletDataHandler
extends BasePortletDataHandler

Author:

Eduardo Garcia

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationPortletDataHandler()

Method Summary

Modifier and Type	Method and Description
javax.portlet.PortletPreferences	deleteData(PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences) Deletes the data created by the portlet.
java.lang.String	exportData(PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences) Returns a string of data to be placed in the <portlet-data> section of the LAR file.
long	getExportModelCount(ManifestSummary manifestSummary) Returns the number of entities defined for this data handler that are available for export according to the provided manifest summary, or -1 if no entities are included in the manifest summary.
protected java.lang.String	getExportPortletPreferencesUuid(PortletDataContext portletDataContext, Portlet portlet, java.lang.String className, long primaryKeyLong)
protected java.lang.Long	getImportPortletPreferencesNewPrimaryKey(PortletDataContext portletDataContext, java.lang.Class<?> clazz, long companyGroupId, java.util.Map<java.lang.Long,java.lang.Long> primaryKeys, java.lang.String uuid)
javax.portlet.PortletPreferences	importData(PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences, java.lang.String data) Handles any special processing of the data when the portlet is imported into a new layout.
protected void	updateExportPortletPreferencesClassPKs(PortletDataContext portletDataContext, Portlet portlet, javax.portlet.PortletPreferences portletPreferences, java.lang.String key, java.lang.String className)
protected void	updateImportPortletPreferencesClassPKs(PortletDataContext portletDataContext, javax.portlet.PortletPreferences portletPreferences, java.lang.String key, java.lang.Class<?> clazz, long companyGroupId)

Methods inherited from class com.liferay.exportimport.kernel.lar.BasePortletDataHandler

addDefaultData, addExportDataRootElement, addImportDataRootElement, addUncheckedModelAdditionCount, doAddDefaultData, doDeleteData, doExportData, doImportData, doPrepareManifestSummary, doProcessExportPortletPreferences, doProcessImportPortletPreferences, doValidateSchemaVersion, getDataLevel, getDataPortletPreferences, getDeletionSystemEventStagedModelTypes, getExportConfigurationControls, getExportConfigurationControls, getExportControls, getExportDataRootElementString, getExportMetadataControls, getExportModelCount, getImportConfigurationControls, getImportConfigurationControls, getImportControls, getImportMetadataControls, getPortletId, getRank, getSchemaVersion, getServiceName, getStagingControls, isDataAlwaysStaged, isDataLocalized, isDataPortalLevel, isDataPortletInstanceLevel, isDataSiteLevel, isDisplayPortlet, isPublishToLiveByDefault, isRollbackOnException, prepareManifestSummary, prepareManifestSummary, processExportPortletPreferences, processImportPortletPreferences, setDataAlwaysStaged, setDataLevel, setDataLocalized, setDataPortletPreferences, setDeletionSystemEventStagedModelTypes, setExportControls, setExportMetadataControls, setImportControls, setImportMetadataControls, setPortletId, setPublishToLiveByDefault, setRank, setStagingControls, setSupportsDataStrategyCopyAsNew, validateSchemaVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.exportimport.kernel.lar.PortletDataHandler

getNamespace, isConfigurationEnabled, isStaged, isSupportsDataStrategyCopyAsNew, isSupportsDataStrategyMirrorWithOverwriting

Constructor Detail

DefaultConfigurationPortletDataHandler

public DefaultConfigurationPortletDataHandler()

Method Detail

deleteData

public javax.portlet.PortletPreferences deleteData(PortletDataContext portletDataContext,
                                                   java.lang.String portletId,
                                                   javax.portlet.PortletPreferences portletPreferences)

Description copied from interface: PortletDataHandler

Deletes the data created by the portlet. It can optionally return a modified version of the portlet preferences if it contains references to data that no longer exists.

Specified by:

deleteData in interface PortletDataHandler

Overrides:

deleteData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data deletion

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

Returns:

a modified version of the portlet preferences that should be saved, or null if the data handler made no changes to the portlet preferences

exportData

public java.lang.String exportData(PortletDataContext portletDataContext,
                                   java.lang.String portletId,
                                   javax.portlet.PortletPreferences portletPreferences)

Description copied from interface: PortletDataHandler

Returns a string of data to be placed in the <portlet-data> section of the LAR file. This data will be passed as the data parameter of importData().

Specified by:

exportData in interface PortletDataHandler

Overrides:

exportData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data export

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

Returns:

a string of data to be placed in the LAR, which can be, but not limited to XML, or null if no portlet data is to be written out

getExportModelCount

public long getExportModelCount(ManifestSummary manifestSummary)

Description copied from interface: PortletDataHandler

Returns the number of entities defined for this data handler that are available for export according to the provided manifest summary, or -1 if no entities are included in the manifest summary.

Specified by:

getExportModelCount in interface PortletDataHandler

Overrides:

getExportModelCount in class BasePortletDataHandler

Parameters:

manifestSummary - the manifest summary listing the number of exportable entities

Returns:

the number of entities that are available for export according to the manifest summary, or -1 if no entities are included in the manifest summary

importData

public javax.portlet.PortletPreferences importData(PortletDataContext portletDataContext,
                                                   java.lang.String portletId,
                                                   javax.portlet.PortletPreferences portletPreferences,
                                                   java.lang.String data)

Description copied from interface: PortletDataHandler

Handles any special processing of the data when the portlet is imported into a new layout. Can optionally return a modified version of preferences to be saved in the new portlet.

Specified by:

importData in interface PortletDataHandler

Overrides:

importData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data import

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

data - the string data that was returned by exportData()

Returns:

a modified version of the portlet preferences that should be saved, or null if the data handler made no changes to the portlet preferences

getExportPortletPreferencesUuid

protected java.lang.String getExportPortletPreferencesUuid(PortletDataContext portletDataContext,
                                                           Portlet portlet,
                                                           java.lang.String className,
                                                           long primaryKeyLong)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getImportPortletPreferencesNewPrimaryKey

protected java.lang.Long getImportPortletPreferencesNewPrimaryKey(PortletDataContext portletDataContext,
                                                                  java.lang.Class<?> clazz,
                                                                  long companyGroupId,
                                                                  java.util.Map<java.lang.Long,java.lang.Long> primaryKeys,
                                                                  java.lang.String uuid)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

updateExportPortletPreferencesClassPKs

protected void updateExportPortletPreferencesClassPKs(PortletDataContext portletDataContext,
                                                      Portlet portlet,
                                                      javax.portlet.PortletPreferences portletPreferences,
                                                      java.lang.String key,
                                                      java.lang.String className)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

updateImportPortletPreferencesClassPKs

protected void updateImportPortletPreferencesClassPKs(PortletDataContext portletDataContext,
                                                      javax.portlet.PortletPreferences portletPreferences,
                                                      java.lang.String key,
                                                      java.lang.Class<?> clazz,
                                                      long companyGroupId)
                                               throws java.lang.Exception

Throws:

java.lang.Exception