com.liferay.portlet.wiki.service.http
Class WikiPageServiceHttp

java.lang.Object
  com.liferay.portlet.wiki.service.http.WikiPageServiceHttp

public class WikiPageServiceHttp
extends java.lang.Object

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

Author:

Brian Wing Shun Chan

See Also:

WikiPageServiceSoap, HttpPrincipal, WikiPageServiceUtil

Generated:

Constructor Summary

WikiPageServiceHttp()

Method Summary

static com.liferay.portlet.wiki.model.WikiPage	addPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.wiki.model.WikiPage	addPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, java.lang.String parentTitle, java.lang.String redirectTitle, com.liferay.portal.service.ServiceContext serviceContext)
static void	addPageAttachment(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.String fileName, java.io.File file)
static void	addPageAttachments(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStream)
static java.lang.String	addTempPageAttachment(HttpPrincipal httpPrincipal, long nodeId, java.lang.String fileName, java.lang.String tempFolderName, java.io.InputStream inputStream)
static void	changeParent(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.String newParentTitle, com.liferay.portal.service.ServiceContext serviceContext)
static void	deletePage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title)
static void	deletePage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, double version)
static void	deletePageAttachment(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.String fileName)
static void	deleteTempPageAttachment(HttpPrincipal httpPrincipal, long nodeId, java.lang.String fileName, java.lang.String tempFolderName)
static com.liferay.portlet.wiki.model.WikiPage	getDraftPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title)
static java.util.List<com.liferay.portlet.wiki.model.WikiPage>	getNodePages(HttpPrincipal httpPrincipal, long nodeId, int max)
static java.lang.String	getNodePagesRSS(HttpPrincipal httpPrincipal, long nodeId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
static com.liferay.portlet.wiki.model.WikiPage	getPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title)
static com.liferay.portlet.wiki.model.WikiPage	getPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.Boolean head)
static com.liferay.portlet.wiki.model.WikiPage	getPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, double version)
static java.lang.String	getPagesRSS(HttpPrincipal httpPrincipal, long companyId, long nodeId, java.lang.String title, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, java.util.Locale locale)
static java.lang.String[]	getTempPageAttachmentNames(HttpPrincipal httpPrincipal, long nodeId, java.lang.String tempFolderName)
static void	movePage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, java.lang.String newTitle, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.wiki.model.WikiPage	revertPage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, double version, com.liferay.portal.service.ServiceContext serviceContext)
static void	subscribePage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title)
static void	unsubscribePage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title)
static com.liferay.portlet.wiki.model.WikiPage	updatePage(HttpPrincipal httpPrincipal, long nodeId, java.lang.String title, double version, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, java.lang.String parentTitle, java.lang.String redirectTitle, com.liferay.portal.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WikiPageServiceHttp

public WikiPageServiceHttp()

Method Detail

addPage

public static com.liferay.portlet.wiki.model.WikiPage addPage(HttpPrincipal httpPrincipal,
                                                              long nodeId,
                                                              java.lang.String title,
                                                              java.lang.String content,
                                                              java.lang.String summary,
                                                              boolean minorEdit,
                                                              com.liferay.portal.service.ServiceContext serviceContext)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addPage

public static com.liferay.portlet.wiki.model.WikiPage addPage(HttpPrincipal httpPrincipal,
                                                              long nodeId,
                                                              java.lang.String title,
                                                              java.lang.String content,
                                                              java.lang.String summary,
                                                              boolean minorEdit,
                                                              java.lang.String format,
                                                              java.lang.String parentTitle,
                                                              java.lang.String redirectTitle,
                                                              com.liferay.portal.service.ServiceContext serviceContext)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addPageAttachment

public static void addPageAttachment(HttpPrincipal httpPrincipal,
                                     long nodeId,
                                     java.lang.String title,
                                     java.lang.String fileName,
                                     java.io.File file)
                              throws com.liferay.portal.kernel.exception.PortalException,
                                     com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addPageAttachments

public static void addPageAttachments(HttpPrincipal httpPrincipal,
                                      long nodeId,
                                      java.lang.String title,
                                      java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStream)
                               throws com.liferay.portal.kernel.exception.PortalException,
                                      com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addTempPageAttachment

public static java.lang.String addTempPageAttachment(HttpPrincipal httpPrincipal,
                                                     long nodeId,
                                                     java.lang.String fileName,
                                                     java.lang.String tempFolderName,
                                                     java.io.InputStream inputStream)
                                              throws com.liferay.portal.kernel.exception.PortalException,
                                                     com.liferay.portal.kernel.exception.SystemException,
                                                     java.io.IOException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

java.io.IOException

changeParent

public static void changeParent(HttpPrincipal httpPrincipal,
                                long nodeId,
                                java.lang.String title,
                                java.lang.String newParentTitle,
                                com.liferay.portal.service.ServiceContext serviceContext)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deletePage

public static void deletePage(HttpPrincipal httpPrincipal,
                              long nodeId,
                              java.lang.String title)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deletePage

public static void deletePage(HttpPrincipal httpPrincipal,
                              long nodeId,
                              java.lang.String title,
                              double version)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deletePageAttachment

public static void deletePageAttachment(HttpPrincipal httpPrincipal,
                                        long nodeId,
                                        java.lang.String title,
                                        java.lang.String fileName)
                                 throws com.liferay.portal.kernel.exception.PortalException,
                                        com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteTempPageAttachment

public static void deleteTempPageAttachment(HttpPrincipal httpPrincipal,
                                            long nodeId,
                                            java.lang.String fileName,
                                            java.lang.String tempFolderName)
                                     throws com.liferay.portal.kernel.exception.PortalException,
                                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getDraftPage

public static com.liferay.portlet.wiki.model.WikiPage getDraftPage(HttpPrincipal httpPrincipal,
                                                                   long nodeId,
                                                                   java.lang.String title)
                                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getNodePages

public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(HttpPrincipal httpPrincipal,
                                                                                   long nodeId,
                                                                                   int max)
                                                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getNodePagesRSS

public static java.lang.String getNodePagesRSS(HttpPrincipal httpPrincipal,
                                               long nodeId,
                                               int max,
                                               java.lang.String type,
                                               double version,
                                               java.lang.String displayStyle,
                                               java.lang.String feedURL,
                                               java.lang.String entryURL)
                                        throws com.liferay.portal.kernel.exception.PortalException,
                                               com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getPage

public static com.liferay.portlet.wiki.model.WikiPage getPage(HttpPrincipal httpPrincipal,
                                                              long nodeId,
                                                              java.lang.String title)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getPage

public static com.liferay.portlet.wiki.model.WikiPage getPage(HttpPrincipal httpPrincipal,
                                                              long nodeId,
                                                              java.lang.String title,
                                                              java.lang.Boolean head)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getPage

public static com.liferay.portlet.wiki.model.WikiPage getPage(HttpPrincipal httpPrincipal,
                                                              long nodeId,
                                                              java.lang.String title,
                                                              double version)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getPagesRSS

public static java.lang.String getPagesRSS(HttpPrincipal httpPrincipal,
                                           long companyId,
                                           long nodeId,
                                           java.lang.String title,
                                           int max,
                                           java.lang.String type,
                                           double version,
                                           java.lang.String displayStyle,
                                           java.lang.String feedURL,
                                           java.lang.String entryURL,
                                           java.util.Locale locale)
                                    throws com.liferay.portal.kernel.exception.PortalException,
                                           com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getTempPageAttachmentNames

public static java.lang.String[] getTempPageAttachmentNames(HttpPrincipal httpPrincipal,
                                                            long nodeId,
                                                            java.lang.String tempFolderName)
                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

movePage

public static void movePage(HttpPrincipal httpPrincipal,
                            long nodeId,
                            java.lang.String title,
                            java.lang.String newTitle,
                            com.liferay.portal.service.ServiceContext serviceContext)
                     throws com.liferay.portal.kernel.exception.PortalException,
                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

revertPage

public static com.liferay.portlet.wiki.model.WikiPage revertPage(HttpPrincipal httpPrincipal,
                                                                 long nodeId,
                                                                 java.lang.String title,
                                                                 double version,
                                                                 com.liferay.portal.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                 com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

subscribePage

public static void subscribePage(HttpPrincipal httpPrincipal,
                                 long nodeId,
                                 java.lang.String title)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

unsubscribePage

public static void unsubscribePage(HttpPrincipal httpPrincipal,
                                   long nodeId,
                                   java.lang.String title)
                            throws com.liferay.portal.kernel.exception.PortalException,
                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updatePage

public static com.liferay.portlet.wiki.model.WikiPage updatePage(HttpPrincipal httpPrincipal,
                                                                 long nodeId,
                                                                 java.lang.String title,
                                                                 double version,
                                                                 java.lang.String content,
                                                                 java.lang.String summary,
                                                                 boolean minorEdit,
                                                                 java.lang.String format,
                                                                 java.lang.String parentTitle,
                                                                 java.lang.String redirectTitle,
                                                                 com.liferay.portal.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                 com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException