com.liferay.exportimport.kernel.staging

Interface Staging

@ProviderType
public interface Staging

Author:

Raymond Augé

Method Summary

Modifier and Type	Method and Description
<T extends BaseModel> void	addModelToChangesetCollection(T model)
long	copyFromLive(PortletRequest portletRequest)
long	copyFromLive(PortletRequest portletRequest, Portlet portlet)
long	copyRemoteLayouts(ExportImportConfiguration exportImportConfiguration)
long	copyRemoteLayouts(long exportImportConfigurationId)
long	copyRemoteLayouts(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout)
long	copyRemoteLayouts(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, String name, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout)
void	deleteLastImportSettings(Group liveGroup, boolean privateLayout)
void	deleteRecentLayoutRevisionId(javax.servlet.http.HttpServletRequest httpServletRequest, long layoutSetBranchId, long plid)
void	deleteRecentLayoutRevisionId(long userId, long layoutSetBranchId, long plid)
JSONArray	getErrorMessagesJSONArray(Locale locale, Map<String,MissingReference> missingReferences)
JSONObject	getExceptionMessagesJSONObject(Locale locale, Exception exception, ExportImportConfiguration exportImportConfiguration)
Group	getLiveGroup(Group group)
Group	getLiveGroup(long groupId)
long	getLiveGroupId(long groupId)
Group	getPermissionStagingGroup(Group group)
long	getRecentLayoutRevisionId(javax.servlet.http.HttpServletRequest httpServletRequest, long layoutSetBranchId, long plid)
long	getRecentLayoutRevisionId(User user, long layoutSetBranchId, long plid)
long	getRecentLayoutSetBranchId(javax.servlet.http.HttpServletRequest httpServletRequest, long layoutSetId)
long	getRecentLayoutSetBranchId(User user, long layoutSetId)
long	getRemoteLayoutPlid(long userId, long stagingGroupId, long plid)
String	getRemoteSiteURL(Group stagingGroup, boolean privateLayout)
String	getSchedulerGroupName(String destinationName, long groupId)
String	getStagedPortletId(String portletId)
long[]	getStagingAndLiveGroupIds(long groupId)
Group	getStagingGroup(long groupId)
JSONArray	getWarningMessagesJSONArray(Locale locale, Map<String,MissingReference> missingReferences)
WorkflowTask	getWorkflowTask(long userId, LayoutRevision layoutRevision)
boolean	hasWorkflowTask(long userId, LayoutRevision layoutRevision)
boolean	isGroupAccessible(Group group, Group fromGroup)
boolean	isGroupAccessible(long groupId, long fromGroupId)
boolean	isIncomplete(Layout layout)
boolean	isIncomplete(Layout layout, long layoutSetBranchId)
boolean	isRemoteLayoutHasPortletId(long userId, long stagingGroupId, long plid, String portletId)
void	populateLastPublishDateCounts(PortletDataContext portletDataContext, StagedModelType[] stagedModelTypes)
void	populateLastPublishDateCounts(PortletDataContext portletDataContext, String[] classNames)
long	publishLayout(long userId, long plid, long liveGroupId, boolean includeChildren)
long	publishLayouts(long userId, ExportImportConfiguration exportImportConfiguration)
long	publishLayouts(long userId, long exportImportConfigurationId)
long	publishLayouts(long userId, long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap)
long	publishLayouts(long userId, long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, String name, Map<String,String[]> parameterMap)
long	publishLayouts(long userId, long sourceGroupId, long targetGroupId, boolean privateLayout, Map<String,String[]> parameterMap)
long	publishPortlet(long userId, ExportImportConfiguration exportImportConfiguration)
long	publishPortlet(long userId, long exportImportConfigurationId)
long	publishPortlet(long userId, long sourceGroupId, long targetGroupId, long sourcePlid, long targetPlid, String portletId, Map<String,String[]> parameterMap)
long	publishToLive(PortletRequest portletRequest)
long	publishToLive(PortletRequest portletRequest, Portlet portlet)
long	publishToRemote(PortletRequest portletRequest)
<T extends BaseModel> void	removeModelFromChangesetCollection(T model)
void	scheduleCopyFromLive(PortletRequest portletRequest)
void	schedulePublishToLive(PortletRequest portletRequest)
void	schedulePublishToRemote(PortletRequest portletRequest)
void	setRecentLayoutBranchId(javax.servlet.http.HttpServletRequest httpServletRequest, long layoutSetBranchId, long plid, long layoutBranchId)
void	setRecentLayoutBranchId(User user, long layoutSetBranchId, long plid, long layoutBranchId)
void	setRecentLayoutRevisionId(javax.servlet.http.HttpServletRequest httpServletRequest, long layoutSetBranchId, long plid, long layoutRevisionId)
void	setRecentLayoutRevisionId(User user, long layoutSetBranchId, long plid, long layoutRevisionId)
void	setRecentLayoutSetBranchId(javax.servlet.http.HttpServletRequest httpServletRequest, long layoutSetId, long layoutSetBranchId)
void	setRecentLayoutSetBranchId(User user, long layoutSetId, long layoutSetBranchId)
String	stripProtocolFromRemoteAddress(String remoteAddress)
void	transferFileToRemoteLive(File file, long stagingRequestId, HttpPrincipal httpPrincipal)
void	unscheduleCopyFromLive(PortletRequest portletRequest)
void	unschedulePublishToLive(PortletRequest portletRequest)
void	unschedulePublishToRemote(PortletRequest portletRequest)
void	updateLastImportSettings(Element layoutElement, Layout layout, PortletDataContext portletDataContext)
void	validateRemoteGroupIsSame(long groupId, long remoteGroupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection)

Method Detail

addModelToChangesetCollection

<T extends BaseModel> void addModelToChangesetCollection(T model)
                                                  throws PortalException

Throws:

PortalException

copyFromLive

long copyFromLive(PortletRequest portletRequest)
           throws PortalException

Throws:

PortalException

copyFromLive

long copyFromLive(PortletRequest portletRequest,
                  Portlet portlet)
           throws PortalException

Throws:

PortalException

copyRemoteLayouts

long copyRemoteLayouts(ExportImportConfiguration exportImportConfiguration)
                throws PortalException

Throws:

PortalException

copyRemoteLayouts

long copyRemoteLayouts(long exportImportConfigurationId)
                throws PortalException

Throws:

PortalException

copyRemoteLayouts

long copyRemoteLayouts(long sourceGroupId,
                       boolean privateLayout,
                       Map<Long,Boolean> layoutIdMap,
                       Map<String,String[]> parameterMap,
                       String remoteAddress,
                       int remotePort,
                       String remotePathContext,
                       boolean secureConnection,
                       long remoteGroupId,
                       boolean remotePrivateLayout)
                throws PortalException

Throws:

PortalException

copyRemoteLayouts

long copyRemoteLayouts(long sourceGroupId,
                       boolean privateLayout,
                       Map<Long,Boolean> layoutIdMap,
                       String name,
                       Map<String,String[]> parameterMap,
                       String remoteAddress,
                       int remotePort,
                       String remotePathContext,
                       boolean secureConnection,
                       long remoteGroupId,
                       boolean remotePrivateLayout)
                throws PortalException

Throws:

PortalException

deleteLastImportSettings

void deleteLastImportSettings(Group liveGroup,
                              boolean privateLayout)
                       throws PortalException

Throws:

PortalException

deleteRecentLayoutRevisionId

void deleteRecentLayoutRevisionId(javax.servlet.http.HttpServletRequest httpServletRequest,
                                  long layoutSetBranchId,
                                  long plid)

deleteRecentLayoutRevisionId

void deleteRecentLayoutRevisionId(long userId,
                                  long layoutSetBranchId,
                                  long plid)

getErrorMessagesJSONArray

JSONArray getErrorMessagesJSONArray(Locale locale,
                                    Map<String,MissingReference> missingReferences)

getExceptionMessagesJSONObject

JSONObject getExceptionMessagesJSONObject(Locale locale,
                                          Exception exception,
                                          ExportImportConfiguration exportImportConfiguration)

getLiveGroup

Group getLiveGroup(Group group)

getLiveGroup

Group getLiveGroup(long groupId)

getLiveGroupId

long getLiveGroupId(long groupId)

getPermissionStagingGroup

Group getPermissionStagingGroup(Group group)

getRecentLayoutRevisionId

long getRecentLayoutRevisionId(javax.servlet.http.HttpServletRequest httpServletRequest,
                               long layoutSetBranchId,
                               long plid)
                        throws PortalException

Throws:

PortalException

getRecentLayoutRevisionId

long getRecentLayoutRevisionId(User user,
                               long layoutSetBranchId,
                               long plid)
                        throws PortalException

Throws:

PortalException

getRecentLayoutSetBranchId

long getRecentLayoutSetBranchId(javax.servlet.http.HttpServletRequest httpServletRequest,
                                long layoutSetId)

getRecentLayoutSetBranchId

long getRecentLayoutSetBranchId(User user,
                                long layoutSetId)

getRemoteLayoutPlid

long getRemoteLayoutPlid(long userId,
                         long stagingGroupId,
                         long plid)
                  throws PortalException

Throws:

PortalException

getRemoteSiteURL

String getRemoteSiteURL(Group stagingGroup,
                        boolean privateLayout)
                 throws PortalException

Throws:

PortalException

getSchedulerGroupName

String getSchedulerGroupName(String destinationName,
                             long groupId)

getStagedPortletId

String getStagedPortletId(String portletId)

getStagingAndLiveGroupIds

long[] getStagingAndLiveGroupIds(long groupId)
                          throws PortalException

Throws:

PortalException

getStagingGroup

Group getStagingGroup(long groupId)

getWarningMessagesJSONArray

JSONArray getWarningMessagesJSONArray(Locale locale,
                                      Map<String,MissingReference> missingReferences)

getWorkflowTask

WorkflowTask getWorkflowTask(long userId,
                             LayoutRevision layoutRevision)
                      throws PortalException

Throws:

PortalException

hasWorkflowTask

boolean hasWorkflowTask(long userId,
                        LayoutRevision layoutRevision)
                 throws PortalException

Throws:

PortalException

isGroupAccessible

boolean isGroupAccessible(Group group,
                          Group fromGroup)

isGroupAccessible

boolean isGroupAccessible(long groupId,
                          long fromGroupId)
                   throws PortalException

Throws:

PortalException

isIncomplete

boolean isIncomplete(Layout layout)

isIncomplete

boolean isIncomplete(Layout layout,
                     long layoutSetBranchId)

isRemoteLayoutHasPortletId

boolean isRemoteLayoutHasPortletId(long userId,
                                   long stagingGroupId,
                                   long plid,
                                   String portletId)

populateLastPublishDateCounts

void populateLastPublishDateCounts(PortletDataContext portletDataContext,
                                   StagedModelType[] stagedModelTypes)
                            throws PortalException

Throws:

PortalException

populateLastPublishDateCounts

void populateLastPublishDateCounts(PortletDataContext portletDataContext,
                                   String[] classNames)
                            throws PortalException

Throws:

PortalException

publishLayout

long publishLayout(long userId,
                   long plid,
                   long liveGroupId,
                   boolean includeChildren)
            throws PortalException

Throws:

PortalException

publishLayouts

long publishLayouts(long userId,
                    ExportImportConfiguration exportImportConfiguration)
             throws PortalException

Throws:

PortalException

publishLayouts

long publishLayouts(long userId,
                    long exportImportConfigurationId)
             throws PortalException

Throws:

PortalException

publishLayouts

long publishLayouts(long userId,
                    long sourceGroupId,
                    long targetGroupId,
                    boolean privateLayout,
                    long[] layoutIds,
                    Map<String,String[]> parameterMap)
             throws PortalException

Throws:

PortalException

publishLayouts

long publishLayouts(long userId,
                    long sourceGroupId,
                    long targetGroupId,
                    boolean privateLayout,
                    long[] layoutIds,
                    String name,
                    Map<String,String[]> parameterMap)
             throws PortalException

Throws:

PortalException

publishLayouts

long publishLayouts(long userId,
                    long sourceGroupId,
                    long targetGroupId,
                    boolean privateLayout,
                    Map<String,String[]> parameterMap)
             throws PortalException

Throws:

PortalException

publishPortlet

long publishPortlet(long userId,
                    ExportImportConfiguration exportImportConfiguration)
             throws PortalException

Throws:

PortalException

publishPortlet

long publishPortlet(long userId,
                    long exportImportConfigurationId)
             throws PortalException

Throws:

PortalException

publishPortlet

long publishPortlet(long userId,
                    long sourceGroupId,
                    long targetGroupId,
                    long sourcePlid,
                    long targetPlid,
                    String portletId,
                    Map<String,String[]> parameterMap)
             throws PortalException

Throws:

PortalException

publishToLive

long publishToLive(PortletRequest portletRequest)
            throws PortalException

Throws:

PortalException

publishToLive

long publishToLive(PortletRequest portletRequest,
                   Portlet portlet)
            throws PortalException

Throws:

PortalException

publishToRemote

long publishToRemote(PortletRequest portletRequest)
              throws PortalException

Throws:

PortalException

removeModelFromChangesetCollection

<T extends BaseModel> void removeModelFromChangesetCollection(T model)
                                                       throws PortalException

Throws:

PortalException

scheduleCopyFromLive

void scheduleCopyFromLive(PortletRequest portletRequest)
                   throws PortalException

Throws:

PortalException

schedulePublishToLive

void schedulePublishToLive(PortletRequest portletRequest)
                    throws PortalException

Throws:

PortalException

schedulePublishToRemote

void schedulePublishToRemote(PortletRequest portletRequest)
                      throws PortalException

Throws:

PortalException

setRecentLayoutBranchId

void setRecentLayoutBranchId(javax.servlet.http.HttpServletRequest httpServletRequest,
                             long layoutSetBranchId,
                             long plid,
                             long layoutBranchId)
                      throws PortalException

Throws:

PortalException

setRecentLayoutBranchId

void setRecentLayoutBranchId(User user,
                             long layoutSetBranchId,
                             long plid,
                             long layoutBranchId)
                      throws PortalException

Throws:

PortalException

setRecentLayoutRevisionId

void setRecentLayoutRevisionId(javax.servlet.http.HttpServletRequest httpServletRequest,
                               long layoutSetBranchId,
                               long plid,
                               long layoutRevisionId)
                        throws PortalException

Throws:

PortalException

setRecentLayoutRevisionId

void setRecentLayoutRevisionId(User user,
                               long layoutSetBranchId,
                               long plid,
                               long layoutRevisionId)
                        throws PortalException

Throws:

PortalException

setRecentLayoutSetBranchId

void setRecentLayoutSetBranchId(javax.servlet.http.HttpServletRequest httpServletRequest,
                                long layoutSetId,
                                long layoutSetBranchId)
                         throws PortalException

Throws:

PortalException

setRecentLayoutSetBranchId

void setRecentLayoutSetBranchId(User user,
                                long layoutSetId,
                                long layoutSetBranchId)
                         throws PortalException

Throws:

PortalException

stripProtocolFromRemoteAddress

String stripProtocolFromRemoteAddress(String remoteAddress)

transferFileToRemoteLive

void transferFileToRemoteLive(File file,
                              long stagingRequestId,
                              HttpPrincipal httpPrincipal)
                       throws Exception

Throws:

Exception

unscheduleCopyFromLive

void unscheduleCopyFromLive(PortletRequest portletRequest)
                     throws PortalException

Throws:

PortalException

unschedulePublishToLive

void unschedulePublishToLive(PortletRequest portletRequest)
                      throws PortalException

Throws:

PortalException

unschedulePublishToRemote

void unschedulePublishToRemote(PortletRequest portletRequest)
                        throws PortalException

Throws:

PortalException

updateLastImportSettings

void updateLastImportSettings(Element layoutElement,
                              Layout layout,
                              PortletDataContext portletDataContext)
                       throws PortalException

Throws:

PortalException

validateRemoteGroupIsSame

void validateRemoteGroupIsSame(long groupId,
                               long remoteGroupId,
                               String remoteAddress,
                               int remotePort,
                               String remotePathContext,
                               boolean secureConnection)
                        throws PortalException

Throws:

PortalException