com.liferay.exportimport.kernel.configuration

Interface ExportImportConfigurationSettingsMapFactory

@ProviderType
public interface ExportImportConfigurationSettingsMapFactory

Provides a way to build a settings map for an ExportImportConfiguration, which can be used to start and control an export, import, or staging process.

Since:

7.0

Author:

Daniel Kocsis, Akos Thurzo

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.io.Serializable>	buildExportLayoutSettingsMap(long userId, long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Locale locale, java.util.TimeZone timeZone)
java.util.Map<java.lang.String,java.io.Serializable>	buildExportLayoutSettingsMap(User user, long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
java.util.Map<java.lang.String,java.io.Serializable>	buildExportPortletSettingsMap(long userId, long sourcePlid, long sourceGroupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Locale locale, java.util.TimeZone timeZone, java.lang.String fileName)
java.util.Map<java.lang.String,java.io.Serializable>	buildExportPortletSettingsMap(User user, long sourcePlid, long sourceGroupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String fileName)
java.util.Map<java.lang.String,java.io.Serializable>	buildImportLayoutSettingsMap(long userId, long targetGroupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Locale locale, java.util.TimeZone timeZone)
java.util.Map<java.lang.String,java.io.Serializable>	buildImportLayoutSettingsMap(User user, long targetGroupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
java.util.Map<java.lang.String,java.io.Serializable>	buildImportPortletSettingsMap(long userId, long targetPlid, long targetGroupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Locale locale, java.util.TimeZone timeZone)
java.util.Map<java.lang.String,java.io.Serializable>	buildImportPortletSettingsMap(User user, long targetPlid, long targetGroupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
java.util.Map<java.lang.String,java.io.Serializable>	buildPublishLayoutLocalSettingsMap(long userId, long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Locale locale, java.util.TimeZone timeZone)
java.util.Map<java.lang.String,java.io.Serializable>	buildPublishLayoutLocalSettingsMap(User user, long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
java.util.Map<java.lang.String,java.io.Serializable>	buildPublishLayoutRemoteSettingsMap(long userId, long sourceGroupId, boolean privateLayout, java.util.Map<java.lang.Long,java.lang.Boolean> layoutIdMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String remoteAddress, int remotePort, java.lang.String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, java.util.Locale locale, java.util.TimeZone timeZone)
java.util.Map<java.lang.String,java.io.Serializable>	buildPublishLayoutRemoteSettingsMap(User user, long sourceGroupId, boolean privateLayout, java.util.Map<java.lang.Long,java.lang.Boolean> layoutIdMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String remoteAddress, int remotePort, java.lang.String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout)
java.util.Map<java.lang.String,java.io.Serializable>	buildPublishPortletSettingsMap(long userId, long sourceGroupId, long sourcePlid, long targetGroupId, long targetPlid, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Locale locale, java.util.TimeZone timeZone)
java.util.Map<java.lang.String,java.io.Serializable>	buildPublishPortletSettingsMap(User user, long sourceGroupId, long sourcePlid, long targetGroupId, long targetPlid, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
java.util.Map<java.lang.String,java.io.Serializable>	buildSettingsMap(javax.portlet.PortletRequest portletRequest, long groupId, int type) Returns an export layout settings map if the type is ExportImportConfigurationConstants.TYPE_EXPORT_LAYOUT; otherwise, returns either a local or remote publish layout settings map, depending on the staging type.

Method Detail

buildExportLayoutSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildExportLayoutSettingsMap(long userId,
                                                                                  long groupId,
                                                                                  boolean privateLayout,
                                                                                  long[] layoutIds,
                                                                                  java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                  java.util.Locale locale,
                                                                                  java.util.TimeZone timeZone)

buildExportLayoutSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildExportLayoutSettingsMap(User user,
                                                                                  long groupId,
                                                                                  boolean privateLayout,
                                                                                  long[] layoutIds,
                                                                                  java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

buildExportPortletSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildExportPortletSettingsMap(long userId,
                                                                                   long sourcePlid,
                                                                                   long sourceGroupId,
                                                                                   java.lang.String portletId,
                                                                                   java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                   java.util.Locale locale,
                                                                                   java.util.TimeZone timeZone,
                                                                                   java.lang.String fileName)

buildExportPortletSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildExportPortletSettingsMap(User user,
                                                                                   long sourcePlid,
                                                                                   long sourceGroupId,
                                                                                   java.lang.String portletId,
                                                                                   java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                   java.lang.String fileName)

buildImportLayoutSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildImportLayoutSettingsMap(long userId,
                                                                                  long targetGroupId,
                                                                                  boolean privateLayout,
                                                                                  long[] layoutIds,
                                                                                  java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                  java.util.Locale locale,
                                                                                  java.util.TimeZone timeZone)

buildImportLayoutSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildImportLayoutSettingsMap(User user,
                                                                                  long targetGroupId,
                                                                                  boolean privateLayout,
                                                                                  long[] layoutIds,
                                                                                  java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

buildImportPortletSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildImportPortletSettingsMap(long userId,
                                                                                   long targetPlid,
                                                                                   long targetGroupId,
                                                                                   java.lang.String portletId,
                                                                                   java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                   java.util.Locale locale,
                                                                                   java.util.TimeZone timeZone)

buildImportPortletSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildImportPortletSettingsMap(User user,
                                                                                   long targetPlid,
                                                                                   long targetGroupId,
                                                                                   java.lang.String portletId,
                                                                                   java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

buildPublishLayoutLocalSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildPublishLayoutLocalSettingsMap(long userId,
                                                                                        long sourceGroupId,
                                                                                        long targetGroupId,
                                                                                        boolean privateLayout,
                                                                                        long[] layoutIds,
                                                                                        java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                        java.util.Locale locale,
                                                                                        java.util.TimeZone timeZone)

buildPublishLayoutLocalSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildPublishLayoutLocalSettingsMap(User user,
                                                                                        long sourceGroupId,
                                                                                        long targetGroupId,
                                                                                        boolean privateLayout,
                                                                                        long[] layoutIds,
                                                                                        java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

buildPublishLayoutRemoteSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildPublishLayoutRemoteSettingsMap(long userId,
                                                                                         long sourceGroupId,
                                                                                         boolean privateLayout,
                                                                                         java.util.Map<java.lang.Long,java.lang.Boolean> layoutIdMap,
                                                                                         java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                         java.lang.String remoteAddress,
                                                                                         int remotePort,
                                                                                         java.lang.String remotePathContext,
                                                                                         boolean secureConnection,
                                                                                         long remoteGroupId,
                                                                                         boolean remotePrivateLayout,
                                                                                         java.util.Locale locale,
                                                                                         java.util.TimeZone timeZone)

buildPublishLayoutRemoteSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildPublishLayoutRemoteSettingsMap(User user,
                                                                                         long sourceGroupId,
                                                                                         boolean privateLayout,
                                                                                         java.util.Map<java.lang.Long,java.lang.Boolean> layoutIdMap,
                                                                                         java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                         java.lang.String remoteAddress,
                                                                                         int remotePort,
                                                                                         java.lang.String remotePathContext,
                                                                                         boolean secureConnection,
                                                                                         long remoteGroupId,
                                                                                         boolean remotePrivateLayout)

buildPublishPortletSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildPublishPortletSettingsMap(long userId,
                                                                                    long sourceGroupId,
                                                                                    long sourcePlid,
                                                                                    long targetGroupId,
                                                                                    long targetPlid,
                                                                                    java.lang.String portletId,
                                                                                    java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                    java.util.Locale locale,
                                                                                    java.util.TimeZone timeZone)

buildPublishPortletSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildPublishPortletSettingsMap(User user,
                                                                                    long sourceGroupId,
                                                                                    long sourcePlid,
                                                                                    long targetGroupId,
                                                                                    long targetPlid,
                                                                                    java.lang.String portletId,
                                                                                    java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

buildSettingsMap

java.util.Map<java.lang.String,java.io.Serializable> buildSettingsMap(javax.portlet.PortletRequest portletRequest,
                                                                      long groupId,
                                                                      int type)
                                                               throws PortalException

Returns an export layout settings map if the type is ExportImportConfigurationConstants.TYPE_EXPORT_LAYOUT; otherwise, returns either a local or remote publish layout settings map, depending on the staging type.

Parameters:

portletRequest - the portlet request

groupId - the primary key of the group

type - the export/import option type

Returns:

an export layout settings map if the type is an export layout; otherwise, returns either a local or remote publish layout settings map, depending on the staging type

Throws:

PortalException