com.liferay.portal.service.http
Class LayoutServiceHttp

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

public class LayoutServiceHttp
extends Object

This class provides a HTTP utility for the 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 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.

See Also:

LayoutServiceSoap, HttpPrincipal, LayoutServiceUtil

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

Constructor Summary

LayoutServiceHttp()

Method Summary

static Layout	addLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
static Layout	addLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
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, Map<String,String[]> parameterMap, Date startDate, Date endDate)
static byte[]	exportLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate)
static File	exportLayoutsAsFile(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
static byte[]	exportPortletInfo(HttpPrincipal httpPrincipal, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
static File	exportPortletInfoAsFile(HttpPrincipal httpPrincipal, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
static String	getLayoutName(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, String languageId)
static LayoutReference[]	getLayoutReferences(HttpPrincipal httpPrincipal, long companyId, String portletId, String preferencesKey, String preferencesValue)
static void	importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)
static void	importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)
static void	importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)
static void	importPortletInfo(HttpPrincipal httpPrincipal, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)
static void	importPortletInfo(HttpPrincipal httpPrincipal, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)
static void	schedulePublishToLive(HttpPrincipal httpPrincipal, long sourceGroupId, long targetGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)
static void	schedulePublishToRemote(HttpPrincipal httpPrincipal, long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)
static void	setLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
static void	unschedulePublishToLive(HttpPrincipal httpPrincipal, long groupId, String jobName, String groupName)
static void	unschedulePublishToRemote(HttpPrincipal httpPrincipal, long groupId, String jobName, String groupName)
static Layout	updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)
static Layout	updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
static Layout	updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, String typeSettings)
static Layout	updateLookAndFeel(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme)
static Layout	updateName(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, String name, String languageId)
static Layout	updateName(HttpPrincipal httpPrincipal, long plid, String name, String languageId)
static Layout	updateParentLayoutId(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
static Layout	updateParentLayoutId(HttpPrincipal httpPrincipal, long plid, long parentPlid)
static Layout	updatePriority(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, int priority)
static 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 Layout addLayout(HttpPrincipal httpPrincipal,
                               long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               Map<Locale,String> localeNamesMap,
                               Map<Locale,String> localeTitlesMap,
                               String description,
                               String type,
                               boolean hidden,
                               String friendlyURL,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addLayout

public static Layout addLayout(HttpPrincipal httpPrincipal,
                               long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               String name,
                               String title,
                               String description,
                               String type,
                               boolean hidden,
                               String friendlyURL,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteLayout

public static void deleteLayout(HttpPrincipal httpPrincipal,
                                long plid)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteLayout

public static void deleteLayout(HttpPrincipal httpPrincipal,
                                long groupId,
                                boolean privateLayout,
                                long layoutId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

exportLayouts

public static byte[] exportLayouts(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   boolean privateLayout,
                                   long[] layoutIds,
                                   Map<String,String[]> parameterMap,
                                   Date startDate,
                                   Date endDate)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

exportLayouts

public static byte[] exportLayouts(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   boolean privateLayout,
                                   Map<String,String[]> parameterMap,
                                   Date startDate,
                                   Date endDate)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

exportLayoutsAsFile

public static File exportLayoutsAsFile(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       boolean privateLayout,
                                       long[] layoutIds,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

exportPortletInfo

public static byte[] exportPortletInfo(HttpPrincipal httpPrincipal,
                                       long plid,
                                       long groupId,
                                       String portletId,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

exportPortletInfoAsFile

public static File exportPortletInfoAsFile(HttpPrincipal httpPrincipal,
                                           long plid,
                                           long groupId,
                                           String portletId,
                                           Map<String,String[]> parameterMap,
                                           Date startDate,
                                           Date endDate)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getLayoutName

public static String getLayoutName(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   String languageId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getLayoutReferences

public static LayoutReference[] getLayoutReferences(HttpPrincipal httpPrincipal,
                                                    long companyId,
                                                    String portletId,
                                                    String preferencesKey,
                                                    String preferencesValue)
                                             throws SystemException

Throws:

SystemException

importLayouts

public static void importLayouts(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 byte[] bytes)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

importLayouts

public static void importLayouts(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 File file)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

importLayouts

public static void importLayouts(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 InputStream is)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

importPortletInfo

public static void importPortletInfo(HttpPrincipal httpPrincipal,
                                     long plid,
                                     long groupId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     File file)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

importPortletInfo

public static void importPortletInfo(HttpPrincipal httpPrincipal,
                                     long plid,
                                     long groupId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     InputStream is)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

schedulePublishToLive

public static void schedulePublishToLive(HttpPrincipal httpPrincipal,
                                         long sourceGroupId,
                                         long targetGroupId,
                                         boolean privateLayout,
                                         Map<Long,Boolean> layoutIdMap,
                                         Map<String,String[]> parameterMap,
                                         String scope,
                                         Date startDate,
                                         Date endDate,
                                         String groupName,
                                         String cronText,
                                         Date schedulerStartDate,
                                         Date schedulerEndDate,
                                         String description)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

schedulePublishToRemote

public static void schedulePublishToRemote(HttpPrincipal httpPrincipal,
                                           long sourceGroupId,
                                           boolean privateLayout,
                                           Map<Long,Boolean> layoutIdMap,
                                           Map<String,String[]> parameterMap,
                                           String remoteAddress,
                                           int remotePort,
                                           boolean secureConnection,
                                           long remoteGroupId,
                                           boolean remotePrivateLayout,
                                           Date startDate,
                                           Date endDate,
                                           String groupName,
                                           String cronText,
                                           Date schedulerStartDate,
                                           Date schedulerEndDate,
                                           String description)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

setLayouts

public static void setLayouts(HttpPrincipal httpPrincipal,
                              long groupId,
                              boolean privateLayout,
                              long parentLayoutId,
                              long[] layoutIds)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

unschedulePublishToLive

public static void unschedulePublishToLive(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String jobName,
                                           String groupName)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

unschedulePublishToRemote

public static void unschedulePublishToRemote(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             String jobName,
                                             String groupName)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

updateLayout

public static Layout updateLayout(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  long parentLayoutId,
                                  Map<Locale,String> localeNamesMap,
                                  Map<Locale,String> localeTitlesMap,
                                  String description,
                                  String type,
                                  boolean hidden,
                                  String friendlyURL,
                                  Boolean iconImage,
                                  byte[] iconBytes,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateLayout

public static Layout updateLayout(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  long parentLayoutId,
                                  Map<Locale,String> localeNamesMap,
                                  Map<Locale,String> localeTitlesMap,
                                  String description,
                                  String type,
                                  boolean hidden,
                                  String friendlyURL,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateLayout

public static Layout updateLayout(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  String typeSettings)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateLookAndFeel

public static Layout updateLookAndFeel(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       boolean privateLayout,
                                       long layoutId,
                                       String themeId,
                                       String colorSchemeId,
                                       String css,
                                       boolean wapTheme)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

updateName

public static Layout updateName(HttpPrincipal httpPrincipal,
                                long groupId,
                                boolean privateLayout,
                                long layoutId,
                                String name,
                                String languageId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateName

public static Layout updateName(HttpPrincipal httpPrincipal,
                                long plid,
                                String name,
                                String languageId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateParentLayoutId

public static Layout updateParentLayoutId(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          boolean privateLayout,
                                          long layoutId,
                                          long parentLayoutId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updateParentLayoutId

public static Layout updateParentLayoutId(HttpPrincipal httpPrincipal,
                                          long plid,
                                          long parentPlid)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updatePriority

public static Layout updatePriority(HttpPrincipal httpPrincipal,
                                    long groupId,
                                    boolean privateLayout,
                                    long layoutId,
                                    int priority)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

updatePriority

public static Layout updatePriority(HttpPrincipal httpPrincipal,
                                    long plid,
                                    int priority)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException