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

java.lang.Object
  extended by com.liferay.portlet.messageboards.service.http.MBMessageServiceHttp

public class MBMessageServiceHttp
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.portlet.messageboards.service.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 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, MBMessageServiceUtil, MBMessageServiceSoap

Constructor Summary
MBMessageServiceHttp()
           
 
Method Summary
static com.liferay.portlet.messageboards.model.MBMessage addDiscussionMessage(HttpPrincipal httpPrincipal, java.lang.String className, long classPK, 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 categoryId, long threadId, long parentMessageId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, boolean anonymous, double priority, 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, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, boolean anonymous, double priority, com.liferay.portal.service.ServiceContext serviceContext)
           
static void deleteDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, java.lang.String className, long classPK, long messageId)
           
static void deleteMessage(HttpPrincipal httpPrincipal, long messageId)
           
static java.util.List<com.liferay.portlet.messageboards.model.MBMessage> getCategoryMessages(HttpPrincipal httpPrincipal, long categoryId, int start, int end)
           
static int getCategoryMessagesCount(HttpPrincipal httpPrincipal, long categoryId)
           
static java.lang.String getCategoryMessagesRSS(HttpPrincipal httpPrincipal, long categoryId, 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 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, 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 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, java.lang.String threadView)
           
static java.lang.String getThreadMessagesRSS(HttpPrincipal httpPrincipal, long threadId, 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 subscribeMessage(HttpPrincipal httpPrincipal, long messageId)
           
static void unsubscribeMessage(HttpPrincipal httpPrincipal, long messageId)
           
static com.liferay.portlet.messageboards.model.MBMessage updateDiscussionMessage(HttpPrincipal httpPrincipal, java.lang.String className, long classPK, 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,byte[]>> files, java.util.List<java.lang.String> existingFiles, double priority, 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,
                                                                                     java.lang.String className,
                                                                                     long classPK,
                                                                                     long threadId,
                                                                                     long parentMessageId,
                                                                                     java.lang.String subject,
                                                                                     java.lang.String body,
                                                                                     com.liferay.portal.service.ServiceContext serviceContext)
                                                                              throws com.liferay.portal.PortalException,
                                                                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                                           long categoryId,
                                                                           java.lang.String subject,
                                                                           java.lang.String body,
                                                                           java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                                                           boolean anonymous,
                                                                           double priority,
                                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.PortalException,
                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addMessage

public static com.liferay.portlet.messageboards.model.MBMessage addMessage(HttpPrincipal httpPrincipal,
                                                                           long categoryId,
                                                                           long threadId,
                                                                           long parentMessageId,
                                                                           java.lang.String subject,
                                                                           java.lang.String body,
                                                                           java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                                                           boolean anonymous,
                                                                           double priority,
                                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.PortalException,
                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteDiscussionMessage

public static void deleteDiscussionMessage(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           java.lang.String className,
                                           long classPK,
                                           long messageId)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteMessage

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

getCategoryMessages

public static java.util.List<com.liferay.portlet.messageboards.model.MBMessage> getCategoryMessages(HttpPrincipal httpPrincipal,
                                                                                                    long categoryId,
                                                                                                    int start,
                                                                                                    int end)
                                                                                             throws com.liferay.portal.PortalException,
                                                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCategoryMessagesCount

public static int getCategoryMessagesCount(HttpPrincipal httpPrincipal,
                                           long categoryId)
                                    throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getCategoryMessagesRSS

public static java.lang.String getCategoryMessagesRSS(HttpPrincipal httpPrincipal,
                                                      long categoryId,
                                                      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.PortalException,
                                                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompanyMessagesRSS

public static java.lang.String getCompanyMessagesRSS(HttpPrincipal httpPrincipal,
                                                     long companyId,
                                                     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.PortalException,
                                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getGroupMessagesRSS

public static java.lang.String getGroupMessagesRSS(HttpPrincipal httpPrincipal,
                                                   long groupId,
                                                   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.PortalException,
                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getGroupMessagesRSS

public static java.lang.String getGroupMessagesRSS(HttpPrincipal httpPrincipal,
                                                   long groupId,
                                                   long userId,
                                                   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.PortalException,
                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getMessage

public static com.liferay.portlet.messageboards.model.MBMessage getMessage(HttpPrincipal httpPrincipal,
                                                                           long messageId)
                                                                    throws com.liferay.portal.PortalException,
                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getMessageDisplay

public static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(HttpPrincipal httpPrincipal,
                                                                                         long messageId,
                                                                                         java.lang.String threadView)
                                                                                  throws com.liferay.portal.PortalException,
                                                                                         com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getThreadMessagesRSS

public static java.lang.String getThreadMessagesRSS(HttpPrincipal httpPrincipal,
                                                    long threadId,
                                                    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.PortalException,
                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

subscribeMessage

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

unsubscribeMessage

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

updateDiscussionMessage

public static com.liferay.portlet.messageboards.model.MBMessage updateDiscussionMessage(HttpPrincipal httpPrincipal,
                                                                                        java.lang.String className,
                                                                                        long classPK,
                                                                                        long messageId,
                                                                                        java.lang.String subject,
                                                                                        java.lang.String body,
                                                                                        com.liferay.portal.service.ServiceContext serviceContext)
                                                                                 throws com.liferay.portal.PortalException,
                                                                                        com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.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,byte[]>> files,
                                                                              java.util.List<java.lang.String> existingFiles,
                                                                              double priority,
                                                                              com.liferay.portal.service.ServiceContext serviceContext)
                                                                       throws com.liferay.portal.PortalException,
                                                                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException