Liferay 6.0.5

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

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

public class MBMessageServiceHttp
extends Object

This class provides a 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.

See Also:
MBMessageServiceSoap, HttpPrincipal, MBMessageServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
MBMessageServiceHttp()
           
 
Method Summary
static MBMessage addDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long threadId, long parentMessageId, String subject, String body, ServiceContext serviceContext)
           
static MBMessage addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, long threadId, long parentMessageId, String subject, String body, List<ObjectValuePair<String,byte[]>> files, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static MBMessage addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, String subject, String body, List<ObjectValuePair<String,byte[]>> files, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static void deleteDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long messageId)
           
static void deleteMessage(HttpPrincipal httpPrincipal, long messageId)
           
static List<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 String getCategoryMessagesRSS(HttpPrincipal httpPrincipal, long groupId, long categoryId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
           
static String getCompanyMessagesRSS(HttpPrincipal httpPrincipal, long companyId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
           
static String getGroupMessagesRSS(HttpPrincipal httpPrincipal, long groupId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
           
static String getGroupMessagesRSS(HttpPrincipal httpPrincipal, long groupId, long userId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
           
static MBMessage getMessage(HttpPrincipal httpPrincipal, long messageId)
           
static MBMessageDisplay getMessageDisplay(HttpPrincipal httpPrincipal, long messageId, int status, String threadView, boolean includePrevAndNext)
           
static List<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 String getThreadMessagesRSS(HttpPrincipal httpPrincipal, long threadId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
           
static void subscribeMessage(HttpPrincipal httpPrincipal, long messageId)
           
static void unsubscribeMessage(HttpPrincipal httpPrincipal, long messageId)
           
static MBMessage updateDiscussionMessage(HttpPrincipal httpPrincipal, String className, long classPK, String permissionClassName, long permissionClassPK, long messageId, String subject, String body, ServiceContext serviceContext)
           
static MBMessage updateMessage(HttpPrincipal httpPrincipal, long messageId, String subject, String body, List<ObjectValuePair<String,byte[]>> files, List<String> existingFiles, double priority, boolean allowPingbacks, 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 MBMessage addDiscussionMessage(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             String className,
                                             long classPK,
                                             String permissionClassName,
                                             long permissionClassPK,
                                             long threadId,
                                             long parentMessageId,
                                             String subject,
                                             String body,
                                             ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

addMessage

public static MBMessage addMessage(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long categoryId,
                                   long threadId,
                                   long parentMessageId,
                                   String subject,
                                   String body,
                                   List<ObjectValuePair<String,byte[]>> files,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

addMessage

public static MBMessage addMessage(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   List<ObjectValuePair<String,byte[]>> files,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

deleteDiscussionMessage

public static void deleteDiscussionMessage(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String className,
                                           long classPK,
                                           String permissionClassName,
                                           long permissionClassPK,
                                           long messageId)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

deleteMessage

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

getCategoryMessages

public static List<MBMessage> getCategoryMessages(HttpPrincipal httpPrincipal,
                                                  long groupId,
                                                  long categoryId,
                                                  int status,
                                                  int start,
                                                  int end)
                                           throws PortalException,
                                                  SystemException
Throws:
PortalException
SystemException

getCategoryMessagesCount

public static int getCategoryMessagesCount(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           long categoryId,
                                           int status)
                                    throws SystemException
Throws:
SystemException

getCategoryMessagesRSS

public static String getCategoryMessagesRSS(HttpPrincipal httpPrincipal,
                                            long groupId,
                                            long categoryId,
                                            int status,
                                            int max,
                                            String type,
                                            double version,
                                            String displayStyle,
                                            String feedURL,
                                            String entryURL,
                                            ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

getCompanyMessagesRSS

public static String getCompanyMessagesRSS(HttpPrincipal httpPrincipal,
                                           long companyId,
                                           int status,
                                           int max,
                                           String type,
                                           double version,
                                           String displayStyle,
                                           String feedURL,
                                           String entryURL,
                                           ThemeDisplay themeDisplay)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getGroupMessagesRSS

public static String getGroupMessagesRSS(HttpPrincipal httpPrincipal,
                                         long groupId,
                                         int status,
                                         int max,
                                         String type,
                                         double version,
                                         String displayStyle,
                                         String feedURL,
                                         String entryURL,
                                         ThemeDisplay themeDisplay)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

getGroupMessagesRSS

public static String getGroupMessagesRSS(HttpPrincipal httpPrincipal,
                                         long groupId,
                                         long userId,
                                         int status,
                                         int max,
                                         String type,
                                         double version,
                                         String displayStyle,
                                         String feedURL,
                                         String entryURL,
                                         ThemeDisplay themeDisplay)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

getMessage

public static MBMessage getMessage(HttpPrincipal httpPrincipal,
                                   long messageId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getMessageDisplay

public static MBMessageDisplay getMessageDisplay(HttpPrincipal httpPrincipal,
                                                 long messageId,
                                                 int status,
                                                 String threadView,
                                                 boolean includePrevAndNext)
                                          throws PortalException,
                                                 SystemException
Throws:
PortalException
SystemException

getThreadMessages

public static List<MBMessage> getThreadMessages(HttpPrincipal httpPrincipal,
                                                long groupId,
                                                long categoryId,
                                                long threadId,
                                                int status,
                                                int start,
                                                int end)
                                         throws SystemException
Throws:
SystemException

getThreadMessagesCount

public static int getThreadMessagesCount(HttpPrincipal httpPrincipal,
                                         long groupId,
                                         long categoryId,
                                         long threadId,
                                         int status)
                                  throws SystemException
Throws:
SystemException

getThreadMessagesRSS

public static String getThreadMessagesRSS(HttpPrincipal httpPrincipal,
                                          long threadId,
                                          int status,
                                          int max,
                                          String type,
                                          double version,
                                          String displayStyle,
                                          String feedURL,
                                          String entryURL,
                                          ThemeDisplay themeDisplay)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

subscribeMessage

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

unsubscribeMessage

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

updateDiscussionMessage

public static MBMessage updateDiscussionMessage(HttpPrincipal httpPrincipal,
                                                String className,
                                                long classPK,
                                                String permissionClassName,
                                                long permissionClassPK,
                                                long messageId,
                                                String subject,
                                                String body,
                                                ServiceContext serviceContext)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

updateMessage

public static MBMessage updateMessage(HttpPrincipal httpPrincipal,
                                      long messageId,
                                      String subject,
                                      String body,
                                      List<ObjectValuePair<String,byte[]>> files,
                                      List<String> existingFiles,
                                      double priority,
                                      boolean allowPingbacks,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5