Liferay 7.0-ce-b4

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

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

@ProviderType
public class MBMessageServiceHttp
extends 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.

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

Constructor Summary
MBMessageServiceHttp()
           
 
Method Summary
static MBMessage addDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, String className, long classPK, 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, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static MBMessage addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static MBMessage addMessage(HttpPrincipal httpPrincipal, long groupId, long categoryId, String subject, String body, String format, String fileName, File file, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static MBMessage addMessage(HttpPrincipal httpPrincipal, long categoryId, String subject, String body, ServiceContext serviceContext)
           
static MBMessage addMessage(HttpPrincipal httpPrincipal, long parentMessageId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static void addMessageAttachment(HttpPrincipal httpPrincipal, long messageId, String fileName, File file, String mimeType)
           
static void deleteDiscussionMessage(HttpPrincipal httpPrincipal, long messageId)
           
static void deleteDiscussionMessage(HttpPrincipal httpPrincipal, long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId)
           
static void deleteMessage(HttpPrincipal httpPrincipal, long messageId)
           
static void deleteMessageAttachment(HttpPrincipal httpPrincipal, long messageId, String fileName)
           
static void deleteMessageAttachments(HttpPrincipal httpPrincipal, long messageId)
           
static void emptyMessageAttachments(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 int getGroupMessagesCount(HttpPrincipal httpPrincipal, long groupId, int status)
           
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, boolean includePrevAndNext)
           
static MBMessageDisplay getMessageDisplay(HttpPrincipal httpPrincipal, long messageId, int status, String threadView, boolean includePrevAndNext)
           
static int getThreadAnswersCount(HttpPrincipal httpPrincipal, long groupId, long categoryId, long threadId)
           
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 restoreMessageAttachmentFromTrash(HttpPrincipal httpPrincipal, long messageId, 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 MBMessage updateDiscussionMessage(HttpPrincipal httpPrincipal, String className, long classPK, long messageId, String subject, String body, ServiceContext serviceContext)
           
static MBMessage updateMessage(HttpPrincipal httpPrincipal, long messageId, String subject, String body, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, 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,
                                             long threadId,
                                             long parentMessageId,
                                             String subject,
                                             String body,
                                             ServiceContext serviceContext)
                                      throws PortalException
Throws:
PortalException

addMessage

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

addMessage

public static MBMessage addMessage(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   String format,
                                   List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException
Throws:
PortalException

addMessage

public static MBMessage addMessage(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   String format,
                                   String fileName,
                                   File file,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   FileNotFoundException
Throws:
PortalException
FileNotFoundException

addMessage

public static MBMessage addMessage(HttpPrincipal httpPrincipal,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   ServiceContext serviceContext)
                            throws PortalException
Throws:
PortalException

addMessage

public static MBMessage addMessage(HttpPrincipal httpPrincipal,
                                   long parentMessageId,
                                   String subject,
                                   String body,
                                   String format,
                                   List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException
Throws:
PortalException

addMessageAttachment

public static void addMessageAttachment(HttpPrincipal httpPrincipal,
                                        long messageId,
                                        String fileName,
                                        File file,
                                        String mimeType)
                                 throws PortalException
Throws:
PortalException

deleteDiscussionMessage

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

deleteDiscussionMessage

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

deleteMessage

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

deleteMessageAttachment

public static void deleteMessageAttachment(HttpPrincipal httpPrincipal,
                                           long messageId,
                                           String fileName)
                                    throws PortalException
Throws:
PortalException

deleteMessageAttachments

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

emptyMessageAttachments

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

getCategoryMessages

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

getCategoryMessagesCount

public static int getCategoryMessagesCount(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           long categoryId,
                                           int status)

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
Throws:
PortalException

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
Throws:
PortalException

getGroupMessagesCount

public static int getGroupMessagesCount(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        int status)

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
Throws:
PortalException

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
Throws:
PortalException

getMessage

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

getMessageDisplay

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

getMessageDisplay

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

getThreadAnswersCount

public static int getThreadAnswersCount(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long categoryId,
                                        long threadId)

getThreadMessages

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

getThreadMessagesCount

public static int getThreadMessagesCount(HttpPrincipal httpPrincipal,
                                         long groupId,
                                         long categoryId,
                                         long threadId,
                                         int status)

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
Throws:
PortalException

restoreMessageAttachmentFromTrash

public static void restoreMessageAttachmentFromTrash(HttpPrincipal httpPrincipal,
                                                     long messageId,
                                                     String fileName)
                                              throws PortalException
Throws:
PortalException

subscribeMessage

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

unsubscribeMessage

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

updateAnswer

public static void updateAnswer(HttpPrincipal httpPrincipal,
                                long messageId,
                                boolean answer,
                                boolean cascade)
                         throws PortalException
Throws:
PortalException

updateDiscussionMessage

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

updateMessage

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

Liferay 7.0-ce-b4