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

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

public class MBCategoryServiceHttp
extends java.lang.Object

This class provides a HTTP utility for the MBCategoryServiceUtil 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:
MBCategoryServiceSoap, HttpPrincipal, MBCategoryServiceUtil
Generated:

Constructor Summary
MBCategoryServiceHttp()
           
 
Method Summary
static com.liferay.portlet.messageboards.model.MBCategory addCategory(HttpPrincipal httpPrincipal, long parentCategoryId, java.lang.String name, java.lang.String description, java.lang.String displayStyle, java.lang.String emailAddress, java.lang.String inProtocol, java.lang.String inServerName, int inServerPort, boolean inUseSSL, java.lang.String inUserName, java.lang.String inPassword, int inReadInterval, java.lang.String outEmailAddress, boolean outCustom, java.lang.String outServerName, int outServerPort, boolean outUseSSL, java.lang.String outUserName, java.lang.String outPassword, boolean mailingListActive, boolean allowAnonymousEmail, com.liferay.portal.service.ServiceContext serviceContext)
           
static void deleteCategory(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId)
           
static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, long[] parentCategoryIds, int start, int end)
           
static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(HttpPrincipal httpPrincipal, long groupId, long parentCategoryId, int start, int end)
           
static int getCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long parentCategoryId)
           
static int getCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long[] parentCategoryIds)
           
static com.liferay.portlet.messageboards.model.MBCategory getCategory(HttpPrincipal httpPrincipal, long categoryId)
           
static long[] getCategoryIds(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static java.util.List<java.lang.Long> getSubcategoryIds(HttpPrincipal httpPrincipal, java.util.List<java.lang.Long> categoryIds, long groupId, long categoryId)
           
static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(HttpPrincipal httpPrincipal, long groupId, long userId, int start, int end)
           
static int getSubscribedCategoriesCount(HttpPrincipal httpPrincipal, long groupId, long userId)
           
static void subscribeCategory(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static void unsubscribeCategory(HttpPrincipal httpPrincipal, long groupId, long categoryId)
           
static com.liferay.portlet.messageboards.model.MBCategory updateCategory(HttpPrincipal httpPrincipal, long categoryId, long parentCategoryId, java.lang.String name, java.lang.String description, java.lang.String displayStyle, java.lang.String emailAddress, java.lang.String inProtocol, java.lang.String inServerName, int inServerPort, boolean inUseSSL, java.lang.String inUserName, java.lang.String inPassword, int inReadInterval, java.lang.String outEmailAddress, boolean outCustom, java.lang.String outServerName, int outServerPort, boolean outUseSSL, java.lang.String outUserName, java.lang.String outPassword, boolean mailingListActive, boolean allowAnonymousEmail, boolean mergeWithParentCategory, 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

MBCategoryServiceHttp

public MBCategoryServiceHttp()
Method Detail

addCategory

public static com.liferay.portlet.messageboards.model.MBCategory addCategory(HttpPrincipal httpPrincipal,
                                                                             long parentCategoryId,
                                                                             java.lang.String name,
                                                                             java.lang.String description,
                                                                             java.lang.String displayStyle,
                                                                             java.lang.String emailAddress,
                                                                             java.lang.String inProtocol,
                                                                             java.lang.String inServerName,
                                                                             int inServerPort,
                                                                             boolean inUseSSL,
                                                                             java.lang.String inUserName,
                                                                             java.lang.String inPassword,
                                                                             int inReadInterval,
                                                                             java.lang.String outEmailAddress,
                                                                             boolean outCustom,
                                                                             java.lang.String outServerName,
                                                                             int outServerPort,
                                                                             boolean outUseSSL,
                                                                             java.lang.String outUserName,
                                                                             java.lang.String outPassword,
                                                                             boolean mailingListActive,
                                                                             boolean allowAnonymousEmail,
                                                                             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

deleteCategory

public static void deleteCategory(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long categoryId)
                           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

getCategories

public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                                                                               long groupId)
                                                                                        throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getCategories

public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                                                                               long groupId,
                                                                                               long parentCategoryId,
                                                                                               int start,
                                                                                               int end)
                                                                                        throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getCategories

public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getCategories(HttpPrincipal httpPrincipal,
                                                                                               long groupId,
                                                                                               long[] parentCategoryIds,
                                                                                               int start,
                                                                                               int end)
                                                                                        throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getCategoriesCount

public static int getCategoriesCount(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long parentCategoryId)
                              throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getCategoriesCount

public static int getCategoriesCount(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long[] parentCategoryIds)
                              throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getCategory

public static com.liferay.portlet.messageboards.model.MBCategory getCategory(HttpPrincipal httpPrincipal,
                                                                             long categoryId)
                                                                      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

getCategoryIds

public static long[] getCategoryIds(HttpPrincipal httpPrincipal,
                                    long groupId,
                                    long categoryId)
                             throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getSubcategoryIds

public static java.util.List<java.lang.Long> getSubcategoryIds(HttpPrincipal httpPrincipal,
                                                               java.util.List<java.lang.Long> categoryIds,
                                                               long groupId,
                                                               long categoryId)
                                                        throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getSubscribedCategories

public static java.util.List<com.liferay.portlet.messageboards.model.MBCategory> getSubscribedCategories(HttpPrincipal httpPrincipal,
                                                                                                         long groupId,
                                                                                                         long userId,
                                                                                                         int start,
                                                                                                         int end)
                                                                                                  throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

getSubscribedCategoriesCount

public static int getSubscribedCategoriesCount(HttpPrincipal httpPrincipal,
                                               long groupId,
                                               long userId)
                                        throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

subscribeCategory

public static void subscribeCategory(HttpPrincipal httpPrincipal,
                                     long groupId,
                                     long categoryId)
                              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

unsubscribeCategory

public static void unsubscribeCategory(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long categoryId)
                                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

updateCategory

public static com.liferay.portlet.messageboards.model.MBCategory updateCategory(HttpPrincipal httpPrincipal,
                                                                                long categoryId,
                                                                                long parentCategoryId,
                                                                                java.lang.String name,
                                                                                java.lang.String description,
                                                                                java.lang.String displayStyle,
                                                                                java.lang.String emailAddress,
                                                                                java.lang.String inProtocol,
                                                                                java.lang.String inServerName,
                                                                                int inServerPort,
                                                                                boolean inUseSSL,
                                                                                java.lang.String inUserName,
                                                                                java.lang.String inPassword,
                                                                                int inReadInterval,
                                                                                java.lang.String outEmailAddress,
                                                                                boolean outCustom,
                                                                                java.lang.String outServerName,
                                                                                int outServerPort,
                                                                                boolean outUseSSL,
                                                                                java.lang.String outUserName,
                                                                                java.lang.String outPassword,
                                                                                boolean mailingListActive,
                                                                                boolean allowAnonymousEmail,
                                                                                boolean mergeWithParentCategory,
                                                                                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