com.liferay.portal.service.http
Class LayoutServiceHttp

java.lang.Object
  extended by com.liferay.portal.service.http.LayoutServiceHttp

public class LayoutServiceHttp
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a HTTP utility for the com.liferay.portal.service.LayoutServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional com.liferay.portal.security.auth.HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
HttpPrincipal, LayoutServiceUtil, LayoutServiceSoap

Constructor Summary
LayoutServiceHttp()
           
 
Method Summary
static com.liferay.portal.model.Layout addLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> localeNamesMap, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL)
           
static com.liferay.portal.model.Layout addLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL)
           
static void deleteLayout(HttpPrincipal httpPrincipal, long plid)
           
static void deleteLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId)
           
static byte[] exportLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
           
static byte[] exportLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
           
static com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
           
static byte[] exportPortletInfo(HttpPrincipal httpPrincipal, long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
           
static com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(HttpPrincipal httpPrincipal, long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
           
static java.lang.String getLayoutName(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, java.lang.String languageId)
           
static com.liferay.portal.model.LayoutReference[] getLayoutReferences(HttpPrincipal httpPrincipal, long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.String preferencesValue)
           
static void importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, byte[] bytes)
           
static void importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file)
           
static void importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream is)
           
static void importPortletInfo(HttpPrincipal httpPrincipal, long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file)
           
static void importPortletInfo(HttpPrincipal httpPrincipal, long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream is)
           
static void schedulePublishToLive(HttpPrincipal httpPrincipal, long sourceGroupId, long targetGroupId, 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 scope, java.util.Date startDate, java.util.Date endDate, java.lang.String groupName, java.lang.String cronText, java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, java.lang.String description)
           
static void schedulePublishToRemote(HttpPrincipal httpPrincipal, 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, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, java.util.Date startDate, java.util.Date endDate, java.lang.String groupName, java.lang.String cronText, java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, java.lang.String description)
           
static void setLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
           
static void unschedulePublishToLive(HttpPrincipal httpPrincipal, long groupId, java.lang.String jobName, java.lang.String groupName)
           
static void unschedulePublishToRemote(HttpPrincipal httpPrincipal, long groupId, java.lang.String jobName, java.lang.String groupName)
           
static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> localeNamesMap, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL)
           
static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> localeNamesMap, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, java.lang.Boolean iconImage, byte[] iconBytes)
           
static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings)
           
static com.liferay.portal.model.Layout updateLookAndFeel(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
           
static com.liferay.portal.model.Layout updateName(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId)
           
static com.liferay.portal.model.Layout updateName(HttpPrincipal httpPrincipal, long plid, java.lang.String name, java.lang.String languageId)
           
static com.liferay.portal.model.Layout updateParentLayoutId(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
           
static com.liferay.portal.model.Layout updateParentLayoutId(HttpPrincipal httpPrincipal, long plid, long parentPlid)
           
static com.liferay.portal.model.Layout updatePriority(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, int priority)
           
static com.liferay.portal.model.Layout updatePriority(HttpPrincipal httpPrincipal, long plid, int priority)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutServiceHttp

public LayoutServiceHttp()
Method Detail

addLayout

public static com.liferay.portal.model.Layout addLayout(HttpPrincipal httpPrincipal,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        long parentLayoutId,
                                                        java.lang.String name,
                                                        java.lang.String title,
                                                        java.lang.String description,
                                                        java.lang.String type,
                                                        boolean hidden,
                                                        java.lang.String friendlyURL)
                                                 throws com.liferay.portal.PortalException,
                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addLayout

public static com.liferay.portal.model.Layout addLayout(HttpPrincipal httpPrincipal,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        long parentLayoutId,
                                                        java.util.Map<java.util.Locale,java.lang.String> localeNamesMap,
                                                        java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                                                        java.lang.String description,
                                                        java.lang.String type,
                                                        boolean hidden,
                                                        java.lang.String friendlyURL)
                                                 throws com.liferay.portal.PortalException,
                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteLayout

public static void deleteLayout(HttpPrincipal httpPrincipal,
                                long plid)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteLayout

public static void deleteLayout(HttpPrincipal httpPrincipal,
                                long groupId,
                                boolean privateLayout,
                                long layoutId)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutName

public static java.lang.String getLayoutName(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             boolean privateLayout,
                                             long layoutId,
                                             java.lang.String languageId)
                                      throws com.liferay.portal.PortalException,
                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutReferences

public static com.liferay.portal.model.LayoutReference[] getLayoutReferences(HttpPrincipal httpPrincipal,
                                                                             long companyId,
                                                                             java.lang.String portletId,
                                                                             java.lang.String preferencesKey,
                                                                             java.lang.String preferencesValue)
                                                                      throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

exportLayouts

public static byte[] exportLayouts(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   boolean privateLayout,
                                   java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                   java.util.Date startDate,
                                   java.util.Date endDate)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

exportLayouts

public static byte[] exportLayouts(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   boolean privateLayout,
                                   long[] layoutIds,
                                   java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                   java.util.Date startDate,
                                   java.util.Date endDate)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

exportLayoutsAsStream

public static com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(HttpPrincipal httpPrincipal,
                                                                                       long groupId,
                                                                                       boolean privateLayout,
                                                                                       long[] layoutIds,
                                                                                       java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                       java.util.Date startDate,
                                                                                       java.util.Date endDate)
                                                                                throws com.liferay.portal.PortalException,
                                                                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

exportPortletInfo

public static byte[] exportPortletInfo(HttpPrincipal httpPrincipal,
                                       long plid,
                                       long groupId,
                                       java.lang.String portletId,
                                       java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                       java.util.Date startDate,
                                       java.util.Date endDate)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

exportPortletInfoAsStream

public static com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(HttpPrincipal httpPrincipal,
                                                                                           long plid,
                                                                                           long groupId,
                                                                                           java.lang.String portletId,
                                                                                           java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                                                           java.util.Date startDate,
                                                                                           java.util.Date endDate)
                                                                                    throws com.liferay.portal.PortalException,
                                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importLayouts

public static void importLayouts(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 boolean privateLayout,
                                 java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                 java.io.File file)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importLayouts

public static void importLayouts(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 boolean privateLayout,
                                 java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                 byte[] bytes)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importLayouts

public static void importLayouts(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 boolean privateLayout,
                                 java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                 java.io.InputStream is)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importPortletInfo

public static void importPortletInfo(HttpPrincipal httpPrincipal,
                                     long plid,
                                     long groupId,
                                     java.lang.String portletId,
                                     java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                     java.io.File file)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

importPortletInfo

public static void importPortletInfo(HttpPrincipal httpPrincipal,
                                     long plid,
                                     long groupId,
                                     java.lang.String portletId,
                                     java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                     java.io.InputStream is)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

schedulePublishToLive

public static void schedulePublishToLive(HttpPrincipal httpPrincipal,
                                         long sourceGroupId,
                                         long targetGroupId,
                                         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 scope,
                                         java.util.Date startDate,
                                         java.util.Date endDate,
                                         java.lang.String groupName,
                                         java.lang.String cronText,
                                         java.util.Date schedulerStartDate,
                                         java.util.Date schedulerEndDate,
                                         java.lang.String description)
                                  throws com.liferay.portal.PortalException,
                                         com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

schedulePublishToRemote

public static void schedulePublishToRemote(HttpPrincipal httpPrincipal,
                                           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,
                                           boolean secureConnection,
                                           long remoteGroupId,
                                           boolean remotePrivateLayout,
                                           java.util.Date startDate,
                                           java.util.Date endDate,
                                           java.lang.String groupName,
                                           java.lang.String cronText,
                                           java.util.Date schedulerStartDate,
                                           java.util.Date schedulerEndDate,
                                           java.lang.String description)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

setLayouts

public static void setLayouts(HttpPrincipal httpPrincipal,
                              long groupId,
                              boolean privateLayout,
                              long parentLayoutId,
                              long[] layoutIds)
                       throws com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

unschedulePublishToLive

public static void unschedulePublishToLive(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           java.lang.String jobName,
                                           java.lang.String groupName)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

unschedulePublishToRemote

public static void unschedulePublishToRemote(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             java.lang.String jobName,
                                             java.lang.String groupName)
                                      throws com.liferay.portal.PortalException,
                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateLayout

public static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           boolean privateLayout,
                                                           long layoutId,
                                                           long parentLayoutId,
                                                           java.util.Map<java.util.Locale,java.lang.String> localeNamesMap,
                                                           java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                                                           java.lang.String description,
                                                           java.lang.String type,
                                                           boolean hidden,
                                                           java.lang.String friendlyURL)
                                                    throws com.liferay.portal.PortalException,
                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateLayout

public static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           boolean privateLayout,
                                                           long layoutId,
                                                           long parentLayoutId,
                                                           java.util.Map<java.util.Locale,java.lang.String> localeNamesMap,
                                                           java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                                                           java.lang.String description,
                                                           java.lang.String type,
                                                           boolean hidden,
                                                           java.lang.String friendlyURL,
                                                           java.lang.Boolean iconImage,
                                                           byte[] iconBytes)
                                                    throws com.liferay.portal.PortalException,
                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateLayout

public static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           boolean privateLayout,
                                                           long layoutId,
                                                           java.lang.String typeSettings)
                                                    throws com.liferay.portal.PortalException,
                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateLookAndFeel

public static com.liferay.portal.model.Layout updateLookAndFeel(HttpPrincipal httpPrincipal,
                                                                long groupId,
                                                                boolean privateLayout,
                                                                long layoutId,
                                                                java.lang.String themeId,
                                                                java.lang.String colorSchemeId,
                                                                java.lang.String css,
                                                                boolean wapTheme)
                                                         throws com.liferay.portal.PortalException,
                                                                com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateName

public static com.liferay.portal.model.Layout updateName(HttpPrincipal httpPrincipal,
                                                         long plid,
                                                         java.lang.String name,
                                                         java.lang.String languageId)
                                                  throws com.liferay.portal.PortalException,
                                                         com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateName

public static com.liferay.portal.model.Layout updateName(HttpPrincipal httpPrincipal,
                                                         long groupId,
                                                         boolean privateLayout,
                                                         long layoutId,
                                                         java.lang.String name,
                                                         java.lang.String languageId)
                                                  throws com.liferay.portal.PortalException,
                                                         com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateParentLayoutId

public static com.liferay.portal.model.Layout updateParentLayoutId(HttpPrincipal httpPrincipal,
                                                                   long plid,
                                                                   long parentPlid)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateParentLayoutId

public static com.liferay.portal.model.Layout updateParentLayoutId(HttpPrincipal httpPrincipal,
                                                                   long groupId,
                                                                   boolean privateLayout,
                                                                   long layoutId,
                                                                   long parentLayoutId)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updatePriority

public static com.liferay.portal.model.Layout updatePriority(HttpPrincipal httpPrincipal,
                                                             long plid,
                                                             int priority)
                                                      throws com.liferay.portal.PortalException,
                                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updatePriority

public static com.liferay.portal.model.Layout updatePriority(HttpPrincipal httpPrincipal,
                                                             long groupId,
                                                             boolean privateLayout,
                                                             long layoutId,
                                                             int priority)
                                                      throws com.liferay.portal.PortalException,
                                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException