com.liferay.portal.service.http
Class LayoutServiceHttp

java.lang.Object
  extended bycom.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.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, java.util.Map parameterMap)
           
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 prefsKey, java.lang.String prefsValue)
           
static void importLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, java.util.Map parameterMap, java.io.File file)
           
static void setLayouts(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
           
static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String languageId, 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.lang.String name, java.lang.String title, java.lang.String languageId, 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.SystemException,
                                                        com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteLayout

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

deleteLayout

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

getLayoutName

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

getLayoutReferences

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

exportLayouts

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

importLayouts

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

setLayouts

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

updateLayout

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

updateLayout

public static com.liferay.portal.model.Layout updateLayout(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           boolean privateLayout,
                                                           long layoutId,
                                                           long parentLayoutId,
                                                           java.lang.String name,
                                                           java.lang.String title,
                                                           java.lang.String languageId,
                                                           java.lang.String description,
                                                           java.lang.String type,
                                                           boolean hidden,
                                                           java.lang.String friendlyURL,
                                                           java.lang.Boolean iconImage,
                                                           byte[] iconBytes)
                                                    throws com.liferay.portal.SystemException,
                                                           com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

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.SystemException,
                                                           com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

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.SystemException,
                                                                com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

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.SystemException,
                                                         com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

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.SystemException,
                                                         com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateParentLayoutId

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

updateParentLayoutId

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

updatePriority

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

updatePriority

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