com.liferay.portlet.messageboards.service.http

Class MBMessageServiceSoap

Object

com.liferay.portlet.messageboards.service.http.MBMessageServiceSoap

@ProviderType
public class MBMessageServiceSoap
extends Object

Provides the SOAP 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 is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of MBMessageSoap. If the method in the service utility returns a MBMessage, that is translated to a MBMessageSoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

MBMessageServiceHttp, MBMessageSoap, MBMessageServiceUtil

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
MBMessageServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.message.boards.kernel.model.MBMessageSoap	addDiscussionMessage(long groupId, String className, long classPK, long threadId, long parentMessageId, String subject, String body, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.message.boards.kernel.model.MBMessageSoap	addMessage(long groupId, long categoryId, String subject, String body, String format, List<com.liferay.portal.kernel.util.ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.message.boards.kernel.model.MBMessageSoap	addMessage(long categoryId, String subject, String body, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.message.boards.kernel.model.MBMessageSoap	addMessage(long parentMessageId, String subject, String body, String format, List<com.liferay.portal.kernel.util.ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	deleteDiscussionMessage(long messageId)
static void	deleteDiscussionMessage(long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId) Deprecated. As of Wilberforce (7.0.x), replaced by deleteDiscussionMessage(long)
static void	deleteMessage(long messageId)
static void	deleteMessageAttachment(long messageId, String fileName)
static void	deleteMessageAttachments(long messageId)
static void	emptyMessageAttachments(long messageId)
static com.liferay.message.boards.kernel.model.MBMessageSoap[]	getCategoryMessages(long groupId, long categoryId, int status, int start, int end)
static int	getCategoryMessagesCount(long groupId, long categoryId, int status)
static int	getGroupMessagesCount(long groupId, int status)
static com.liferay.message.boards.kernel.model.MBMessageSoap	getMessage(long messageId)
static int	getThreadAnswersCount(long groupId, long categoryId, long threadId)
static com.liferay.message.boards.kernel.model.MBMessageSoap[]	getThreadMessages(long groupId, long categoryId, long threadId, int status, int start, int end)
static int	getThreadMessagesCount(long groupId, long categoryId, long threadId, int status)
static void	restoreMessageAttachmentFromTrash(long messageId, String fileName)
static void	subscribeMessage(long messageId)
static void	unsubscribeMessage(long messageId)
static void	updateAnswer(long messageId, boolean answer, boolean cascade)
static com.liferay.message.boards.kernel.model.MBMessageSoap	updateDiscussionMessage(String className, long classPK, long messageId, String subject, String body, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.message.boards.kernel.model.MBMessageSoap	updateMessage(long messageId, String subject, String body, List<com.liferay.portal.kernel.util.ObjectValuePair<String,InputStream>> inputStreamOVPs, List<String> existingFiles, double priority, boolean allowPingbacks, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class Object

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

Constructor Detail

MBMessageServiceSoap

public MBMessageServiceSoap()

Method Detail

addDiscussionMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap addDiscussionMessage(long groupId,
                                                                                         String className,
                                                                                         long classPK,
                                                                                         long threadId,
                                                                                         long parentMessageId,
                                                                                         String subject,
                                                                                         String body,
                                                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                  throws RemoteException

Throws:

RemoteException

addMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap addMessage(long groupId,
                                                                               long categoryId,
                                                                               String subject,
                                                                               String body,
                                                                               String format,
                                                                               List<com.liferay.portal.kernel.util.ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                                                               boolean anonymous,
                                                                               double priority,
                                                                               boolean allowPingbacks,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws RemoteException

Throws:

RemoteException

addMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap addMessage(long categoryId,
                                                                               String subject,
                                                                               String body,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws RemoteException

Throws:

RemoteException

addMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap addMessage(long parentMessageId,
                                                                               String subject,
                                                                               String body,
                                                                               String format,
                                                                               List<com.liferay.portal.kernel.util.ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                                                               boolean anonymous,
                                                                               double priority,
                                                                               boolean allowPingbacks,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws RemoteException

Throws:

RemoteException

deleteDiscussionMessage

public static void deleteDiscussionMessage(long messageId)
                                    throws RemoteException

Throws:

RemoteException

deleteDiscussionMessage

@Deprecated
public static void deleteDiscussionMessage(long groupId,
                                                       String className,
                                                       long classPK,
                                                       String permissionClassName,
                                                       long permissionClassPK,
                                                       long permissionOwnerId,
                                                       long messageId)
                                                throws RemoteException

Deprecated. As of Wilberforce (7.0.x), replaced by deleteDiscussionMessage(long)

Throws:

RemoteException

deleteMessage

public static void deleteMessage(long messageId)
                          throws RemoteException

Throws:

RemoteException

deleteMessageAttachment

public static void deleteMessageAttachment(long messageId,
                                           String fileName)
                                    throws RemoteException

Throws:

RemoteException

deleteMessageAttachments

public static void deleteMessageAttachments(long messageId)
                                     throws RemoteException

Throws:

RemoteException

emptyMessageAttachments

public static void emptyMessageAttachments(long messageId)
                                    throws RemoteException

Throws:

RemoteException

getCategoryMessages

public static com.liferay.message.boards.kernel.model.MBMessageSoap[] getCategoryMessages(long groupId,
                                                                                          long categoryId,
                                                                                          int status,
                                                                                          int start,
                                                                                          int end)
                                                                                   throws RemoteException

Throws:

RemoteException

getCategoryMessagesCount

public static int getCategoryMessagesCount(long groupId,
                                           long categoryId,
                                           int status)
                                    throws RemoteException

Throws:

RemoteException

getGroupMessagesCount

public static int getGroupMessagesCount(long groupId,
                                        int status)
                                 throws RemoteException

Throws:

RemoteException

getMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap getMessage(long messageId)
                                                                        throws RemoteException

Throws:

RemoteException

getThreadAnswersCount

public static int getThreadAnswersCount(long groupId,
                                        long categoryId,
                                        long threadId)
                                 throws RemoteException

Throws:

RemoteException

getThreadMessages

public static com.liferay.message.boards.kernel.model.MBMessageSoap[] getThreadMessages(long groupId,
                                                                                        long categoryId,
                                                                                        long threadId,
                                                                                        int status,
                                                                                        int start,
                                                                                        int end)
                                                                                 throws RemoteException

Throws:

RemoteException

getThreadMessagesCount

public static int getThreadMessagesCount(long groupId,
                                         long categoryId,
                                         long threadId,
                                         int status)
                                  throws RemoteException

Throws:

RemoteException

restoreMessageAttachmentFromTrash

public static void restoreMessageAttachmentFromTrash(long messageId,
                                                     String fileName)
                                              throws RemoteException

Throws:

RemoteException

subscribeMessage

public static void subscribeMessage(long messageId)
                             throws RemoteException

Throws:

RemoteException

unsubscribeMessage

public static void unsubscribeMessage(long messageId)
                               throws RemoteException

Throws:

RemoteException

updateAnswer

public static void updateAnswer(long messageId,
                                boolean answer,
                                boolean cascade)
                         throws RemoteException

Throws:

RemoteException

updateDiscussionMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap updateDiscussionMessage(String className,
                                                                                            long classPK,
                                                                                            long messageId,
                                                                                            String subject,
                                                                                            String body,
                                                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                     throws RemoteException

Throws:

RemoteException

updateMessage

public static com.liferay.message.boards.kernel.model.MBMessageSoap updateMessage(long messageId,
                                                                                  String subject,
                                                                                  String body,
                                                                                  List<com.liferay.portal.kernel.util.ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                                                                  List<String> existingFiles,
                                                                                  double priority,
                                                                                  boolean allowPingbacks,
                                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                           throws RemoteException

Throws:

RemoteException