com.liferay.portlet.messageboards.service.http

Class MBMessageServiceHttp

java.lang.Object

com.liferay.portlet.messageboards.service.http.MBMessageServiceHttp

public class MBMessageServiceHttp
extends java.lang.Object

Provides the HTTP utility for the MBMessageServiceUtil 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:

MBMessageServiceSoap, HttpPrincipal, MBMessageServiceUtil

Generated:

Constructor Summary

Constructors

Constructor and Description
MBMessageServiceHttp()

Method Summary

Methods

Modifier and Type	Method and Description
static com.liferay.portlet.messageboards.model.MBMessage	addDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, java.lang.String className, long classPK, java.lang.String permissionClassName, long permissionClassPK, long permissionOwnerId, long threadId, long parentMessageId, java.lang.String subject, java.lang.String body, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, long threadId, long parentMessageId, java.lang.String subject, java.lang.String body, java.lang.String format, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, java.lang.String subject, java.lang.String body, java.lang.String fileName, java.io.File file, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, java.lang.String subject, java.lang.String body, java.lang.String format, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, java.lang.String subject, java.lang.String body, java.lang.String format, java.lang.String fileName, java.io.File file, boolean anonymous, double priority, boolean allowPingbacks, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	addMessage(HttpPrincipal httpPrincipal, long categoryId, java.lang.String subject, java.lang.String body, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	addMessage(HttpPrincipal httpPrincipal, long parentMessageId, java.lang.String subject, java.lang.String body, java.lang.String format, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, java.lang.String className, long classPK, java.lang.String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId)
static void	deleteMessage(HttpPrincipal httpPrincipal, long messageId)
static void	deleteMessageAttachments(HttpPrincipal httpPrincipal, long messageId)
static java.util.List<com.liferay.portlet.messageboards.model.MBMessage>	getCategoryMessages(HttpPrincipal httpPrincipal, long groupId, long categoryId, int status, int start, int end)
static int	getCategoryMessagesCount(HttpPrincipal httpPrincipal, long groupId, long categoryId, int status)
static java.lang.String	getCategoryMessagesRSS(HttpPrincipal httpPrincipal, long groupId, long categoryId, int status, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, com.liferay.portal.theme.ThemeDisplay themeDisplay)
static java.lang.String	getCompanyMessagesRSS(HttpPrincipal httpPrincipal, long companyId, int status, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, com.liferay.portal.theme.ThemeDisplay themeDisplay)
static int	getGroupMessagesCount(HttpPrincipal httpPrincipal, long groupId, int status)
static java.lang.String	getGroupMessagesRSS(HttpPrincipal httpPrincipal, long groupId, int status, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, com.liferay.portal.theme.ThemeDisplay themeDisplay)
static java.lang.String	getGroupMessagesRSS(HttpPrincipal httpPrincipal, long groupId, long userId, int status, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, com.liferay.portal.theme.ThemeDisplay themeDisplay)
static com.liferay.portlet.messageboards.model.MBMessage	getMessage(HttpPrincipal httpPrincipal, long messageId)
static com.liferay.portlet.messageboards.model.MBMessageDisplay	getMessageDisplay(HttpPrincipal httpPrincipal, long messageId, int status, java.lang.String threadView, boolean includePrevAndNext)
static int	getThreadAnswersCount(HttpPrincipal httpPrincipal, long groupId, long categoryId, long threadId)
static java.util.List<com.liferay.portlet.messageboards.model.MBMessage>	getThreadMessages(HttpPrincipal httpPrincipal, long groupId, long categoryId, long threadId, int status, int start, int end)
static int	getThreadMessagesCount(HttpPrincipal httpPrincipal, long groupId, long categoryId, long threadId, int status)
static java.lang.String	getThreadMessagesRSS(HttpPrincipal httpPrincipal, long threadId, int status, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, com.liferay.portal.theme.ThemeDisplay themeDisplay)
static void	restoreMessageAttachmentFromTrash(HttpPrincipal httpPrincipal, long messageId, java.lang.String fileName)
static void	subscribeMessage(HttpPrincipal httpPrincipal, long messageId)
static void	unsubscribeMessage(HttpPrincipal httpPrincipal, long messageId)
static void	updateAnswer(HttpPrincipal httpPrincipal, long messageId, boolean answer, boolean cascade)
static com.liferay.portlet.messageboards.model.MBMessage	updateDiscussionMessage(HttpPrincipal httpPrincipal, java.lang.String className, long classPK, java.lang.String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId, java.lang.String subject, java.lang.String body, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portlet.messageboards.model.MBMessage	updateMessage(HttpPrincipal httpPrincipal, long messageId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs, java.util.List<java.lang.String> existingFiles, double priority, boolean allowPingbacks, 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

MBMessageServiceHttp

public MBMessageServiceHttp()

Method Detail

addDiscussionMessage

public static com.liferay.portlet.messageboards.model.MBMessage addDiscussionMessage(HttpPrincipal httpPrincipal,
                                                                     long groupId,
                                                                     java.lang.String className,
                                                                     long classPK,
                                                                     java.lang.String permissionClassName,
                                                                     long permissionClassPK,
                                                                     long permissionOwnerId,
                                                                     long threadId,
                                                                     long parentMessageId,
                                                                     java.lang.String subject,
                                                                     java.lang.String body,
                                                                     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

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           long categoryId,
                                                           long threadId,
                                                           long parentMessageId,
                                                           java.lang.String subject,
                                                           java.lang.String body,
                                                           java.lang.String format,
                                                           java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs,
                                                           boolean anonymous,
                                                           double priority,
                                                           boolean allowPingbacks,
                                                           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

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           long categoryId,
                                                           java.lang.String subject,
                                                           java.lang.String body,
                                                           java.lang.String fileName,
                                                           java.io.File file,
                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException,
                                                                           java.io.FileNotFoundException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

java.io.FileNotFoundException

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           long categoryId,
                                                           java.lang.String subject,
                                                           java.lang.String body,
                                                           java.lang.String format,
                                                           java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs,
                                                           boolean anonymous,
                                                           double priority,
                                                           boolean allowPingbacks,
                                                           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

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           long categoryId,
                                                           java.lang.String subject,
                                                           java.lang.String body,
                                                           java.lang.String format,
                                                           java.lang.String fileName,
                                                           java.io.File file,
                                                           boolean anonymous,
                                                           double priority,
                                                           boolean allowPingbacks,
                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException,
                                                                           java.io.FileNotFoundException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

java.io.FileNotFoundException

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                           long categoryId,
                                                           java.lang.String subject,
                                                           java.lang.String body,
                                                           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

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                           long parentMessageId,
                                                           java.lang.String subject,
                                                           java.lang.String body,
                                                           java.lang.String format,
                                                           java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs,
                                                           boolean anonymous,
                                                           double priority,
                                                           boolean allowPingbacks,
                                                           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

deleteDiscussionMessage

public static void deleteDiscussionMessage(HttpPrincipal httpPrincipal,
                           long groupId,
                           java.lang.String className,
                           long classPK,
                           java.lang.String permissionClassName,
                           long permissionClassPK,
                           long permissionOwnerId,
                           long messageId)
                                    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

deleteMessage

public static void deleteMessage(HttpPrincipal httpPrincipal,
                 long messageId)
                          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

deleteMessageAttachments

public static void deleteMessageAttachments(HttpPrincipal httpPrincipal,
                            long messageId)
                                     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

getCategoryMessages

public static java.util.List<com.liferay.portlet.messageboards.model.MBMessage> getCategoryMessages(HttpPrincipal httpPrincipal,
                                                                                    long groupId,
                                                                                    long categoryId,
                                                                                    int status,
                                                                                    int start,
                                                                                    int end)
                                                                                             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

getCategoryMessagesCount

public static int getCategoryMessagesCount(HttpPrincipal httpPrincipal,
                           long groupId,
                           long categoryId,
                           int status)
                                    throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getCategoryMessagesRSS

public static java.lang.String getCategoryMessagesRSS(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      long categoryId,
                                      int status,
                                      int max,
                                      java.lang.String type,
                                      double version,
                                      java.lang.String displayStyle,
                                      java.lang.String feedURL,
                                      java.lang.String entryURL,
                                      com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                               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

getCompanyMessagesRSS

public static java.lang.String getCompanyMessagesRSS(HttpPrincipal httpPrincipal,
                                     long companyId,
                                     int status,
                                     int max,
                                     java.lang.String type,
                                     double version,
                                     java.lang.String displayStyle,
                                     java.lang.String feedURL,
                                     java.lang.String entryURL,
                                     com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                              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

getGroupMessagesCount

public static int getGroupMessagesCount(HttpPrincipal httpPrincipal,
                        long groupId,
                        int status)
                                 throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getGroupMessagesRSS

public static java.lang.String getGroupMessagesRSS(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   int status,
                                   int max,
                                   java.lang.String type,
                                   double version,
                                   java.lang.String displayStyle,
                                   java.lang.String feedURL,
                                   java.lang.String entryURL,
                                   com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                            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

getGroupMessagesRSS

public static java.lang.String getGroupMessagesRSS(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long userId,
                                   int status,
                                   int max,
                                   java.lang.String type,
                                   double version,
                                   java.lang.String displayStyle,
                                   java.lang.String feedURL,
                                   java.lang.String entryURL,
                                   com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                            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

getMessage

public static com.liferay.portlet.messageboards.model.MBMessage getMessage(HttpPrincipal httpPrincipal,
                                                           long messageId)
                                                                    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

getMessageDisplay

public static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(HttpPrincipal httpPrincipal,
                                                                         long messageId,
                                                                         int status,
                                                                         java.lang.String threadView,
                                                                         boolean includePrevAndNext)
                                                                                  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

getThreadAnswersCount

public static int getThreadAnswersCount(HttpPrincipal httpPrincipal,
                        long groupId,
                        long categoryId,
                        long threadId)
                                 throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getThreadMessages

public static java.util.List<com.liferay.portlet.messageboards.model.MBMessage> getThreadMessages(HttpPrincipal httpPrincipal,
                                                                                  long groupId,
                                                                                  long categoryId,
                                                                                  long threadId,
                                                                                  int status,
                                                                                  int start,
                                                                                  int end)
                                                                                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getThreadMessagesCount

public static int getThreadMessagesCount(HttpPrincipal httpPrincipal,
                         long groupId,
                         long categoryId,
                         long threadId,
                         int status)
                                  throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getThreadMessagesRSS

public static java.lang.String getThreadMessagesRSS(HttpPrincipal httpPrincipal,
                                    long threadId,
                                    int status,
                                    int max,
                                    java.lang.String type,
                                    double version,
                                    java.lang.String displayStyle,
                                    java.lang.String feedURL,
                                    java.lang.String entryURL,
                                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                             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

restoreMessageAttachmentFromTrash

public static void restoreMessageAttachmentFromTrash(HttpPrincipal httpPrincipal,
                                     long messageId,
                                     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

subscribeMessage

public static void subscribeMessage(HttpPrincipal httpPrincipal,
                    long messageId)
                             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

unsubscribeMessage

public static void unsubscribeMessage(HttpPrincipal httpPrincipal,
                      long messageId)
                               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

updateAnswer

public static void updateAnswer(HttpPrincipal httpPrincipal,
                long messageId,
                boolean answer,
                boolean cascade)
                         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

updateDiscussionMessage

public static com.liferay.portlet.messageboards.model.MBMessage updateDiscussionMessage(HttpPrincipal httpPrincipal,
                                                                        java.lang.String className,
                                                                        long classPK,
                                                                        java.lang.String permissionClassName,
                                                                        long permissionClassPK,
                                                                        long permissionOwnerId,
                                                                        long messageId,
                                                                        java.lang.String subject,
                                                                        java.lang.String body,
                                                                        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

updateMessage

public static com.liferay.portlet.messageboards.model.MBMessage updateMessage(HttpPrincipal httpPrincipal,
                                                              long messageId,
                                                              java.lang.String subject,
                                                              java.lang.String body,
                                                              java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs,
                                                              java.util.List<java.lang.String> existingFiles,
                                                              double priority,
                                                              boolean allowPingbacks,
                                                              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