com.liferay.portlet.journal.service.http
Class JournalArticleServiceHttp

java.lang.Object
  extended by com.liferay.portlet.journal.service.http.JournalArticleServiceHttp

public class JournalArticleServiceHttp
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.journal.service.JournalArticleServiceUtil 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, JournalArticleServiceUtil, JournalArticleServiceSoap

Constructor Summary
JournalArticleServiceHttp()
           
 
Method Summary
static com.liferay.portlet.journal.model.JournalArticle addArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, boolean autoArticleId, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String structureId, java.lang.String templateId, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext)
           
static com.liferay.portlet.journal.model.JournalArticle addArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, boolean autoArticleId, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String structureId, java.lang.String templateId, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext)
           
static com.liferay.portlet.journal.model.JournalArticle approveArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext)
           
static com.liferay.portlet.journal.model.JournalArticle copyArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String oldArticleId, java.lang.String newArticleId, boolean autoArticleId, double version)
           
static void deleteArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext)
           
static void expireArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext)
           
static com.liferay.portlet.journal.model.JournalArticle getArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId)
           
static com.liferay.portlet.journal.model.JournalArticle getArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version)
           
static com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle(HttpPrincipal httpPrincipal, long groupId, java.lang.String urlTitle)
           
static java.lang.String getArticleContent(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, java.lang.String languageId, com.liferay.portal.theme.ThemeDisplay themeDisplay)
           
static java.lang.String getArticleContent(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, java.lang.String languageId, com.liferay.portal.theme.ThemeDisplay themeDisplay)
           
static void removeArticleLocale(HttpPrincipal httpPrincipal, long companyId, java.lang.String languageId)
           
static com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, java.lang.String languageId)
           
static com.liferay.portlet.journal.model.JournalArticle updateArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, boolean incrementVersion, java.lang.String content)
           
static com.liferay.portlet.journal.model.JournalArticle updateArticle(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, boolean incrementVersion, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String structureId, java.lang.String templateId, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext)
           
static com.liferay.portlet.journal.model.JournalArticle updateContent(HttpPrincipal httpPrincipal, long groupId, java.lang.String articleId, double version, java.lang.String content)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalArticleServiceHttp

public JournalArticleServiceHttp()
Method Detail

addArticle

public static com.liferay.portlet.journal.model.JournalArticle addArticle(HttpPrincipal httpPrincipal,
                                                                          long groupId,
                                                                          java.lang.String articleId,
                                                                          boolean autoArticleId,
                                                                          java.lang.String title,
                                                                          java.lang.String description,
                                                                          java.lang.String content,
                                                                          java.lang.String type,
                                                                          java.lang.String structureId,
                                                                          java.lang.String templateId,
                                                                          int displayDateMonth,
                                                                          int displayDateDay,
                                                                          int displayDateYear,
                                                                          int displayDateHour,
                                                                          int displayDateMinute,
                                                                          int expirationDateMonth,
                                                                          int expirationDateDay,
                                                                          int expirationDateYear,
                                                                          int expirationDateHour,
                                                                          int expirationDateMinute,
                                                                          boolean neverExpire,
                                                                          int reviewDateMonth,
                                                                          int reviewDateDay,
                                                                          int reviewDateYear,
                                                                          int reviewDateHour,
                                                                          int reviewDateMinute,
                                                                          boolean neverReview,
                                                                          boolean indexable,
                                                                          java.lang.String articleURL,
                                                                          com.liferay.portal.service.ServiceContext serviceContext)
                                                                   throws com.liferay.portal.PortalException,
                                                                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addArticle

public static com.liferay.portlet.journal.model.JournalArticle addArticle(HttpPrincipal httpPrincipal,
                                                                          long groupId,
                                                                          java.lang.String articleId,
                                                                          boolean autoArticleId,
                                                                          java.lang.String title,
                                                                          java.lang.String description,
                                                                          java.lang.String content,
                                                                          java.lang.String type,
                                                                          java.lang.String structureId,
                                                                          java.lang.String templateId,
                                                                          int displayDateMonth,
                                                                          int displayDateDay,
                                                                          int displayDateYear,
                                                                          int displayDateHour,
                                                                          int displayDateMinute,
                                                                          int expirationDateMonth,
                                                                          int expirationDateDay,
                                                                          int expirationDateYear,
                                                                          int expirationDateHour,
                                                                          int expirationDateMinute,
                                                                          boolean neverExpire,
                                                                          int reviewDateMonth,
                                                                          int reviewDateDay,
                                                                          int reviewDateYear,
                                                                          int reviewDateHour,
                                                                          int reviewDateMinute,
                                                                          boolean neverReview,
                                                                          boolean indexable,
                                                                          boolean smallImage,
                                                                          java.lang.String smallImageURL,
                                                                          java.io.File smallFile,
                                                                          java.util.Map<java.lang.String,byte[]> images,
                                                                          java.lang.String articleURL,
                                                                          com.liferay.portal.service.ServiceContext serviceContext)
                                                                   throws com.liferay.portal.PortalException,
                                                                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

approveArticle

public static com.liferay.portlet.journal.model.JournalArticle approveArticle(HttpPrincipal httpPrincipal,
                                                                              long groupId,
                                                                              java.lang.String articleId,
                                                                              double version,
                                                                              java.lang.String articleURL,
                                                                              com.liferay.portal.service.ServiceContext serviceContext)
                                                                       throws com.liferay.portal.PortalException,
                                                                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

copyArticle

public static com.liferay.portlet.journal.model.JournalArticle copyArticle(HttpPrincipal httpPrincipal,
                                                                           long groupId,
                                                                           java.lang.String oldArticleId,
                                                                           java.lang.String newArticleId,
                                                                           boolean autoArticleId,
                                                                           double version)
                                                                    throws com.liferay.portal.PortalException,
                                                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getArticle

public static com.liferay.portlet.journal.model.JournalArticle getArticle(HttpPrincipal httpPrincipal,
                                                                          long groupId,
                                                                          java.lang.String articleId)
                                                                   throws com.liferay.portal.PortalException,
                                                                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getArticle

public static com.liferay.portlet.journal.model.JournalArticle getArticle(HttpPrincipal httpPrincipal,
                                                                          long groupId,
                                                                          java.lang.String articleId,
                                                                          double version)
                                                                   throws com.liferay.portal.PortalException,
                                                                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getArticleByUrlTitle

public static com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle(HttpPrincipal httpPrincipal,
                                                                                    long groupId,
                                                                                    java.lang.String urlTitle)
                                                                             throws com.liferay.portal.PortalException,
                                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getArticleContent

public static java.lang.String getArticleContent(HttpPrincipal httpPrincipal,
                                                 long groupId,
                                                 java.lang.String articleId,
                                                 java.lang.String languageId,
                                                 com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                          throws com.liferay.portal.PortalException,
                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getArticleContent

public static java.lang.String getArticleContent(HttpPrincipal httpPrincipal,
                                                 long groupId,
                                                 java.lang.String articleId,
                                                 double version,
                                                 java.lang.String languageId,
                                                 com.liferay.portal.theme.ThemeDisplay themeDisplay)
                                          throws com.liferay.portal.PortalException,
                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteArticle

public static void deleteArticle(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 java.lang.String articleId,
                                 double version,
                                 java.lang.String articleURL,
                                 com.liferay.portal.service.ServiceContext serviceContext)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

expireArticle

public static void expireArticle(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 java.lang.String articleId,
                                 double version,
                                 java.lang.String articleURL,
                                 com.liferay.portal.service.ServiceContext serviceContext)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

removeArticleLocale

public static void removeArticleLocale(HttpPrincipal httpPrincipal,
                                       long companyId,
                                       java.lang.String languageId)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

removeArticleLocale

public static com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(HttpPrincipal httpPrincipal,
                                                                                   long groupId,
                                                                                   java.lang.String articleId,
                                                                                   double version,
                                                                                   java.lang.String languageId)
                                                                            throws com.liferay.portal.PortalException,
                                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateArticle

public static com.liferay.portlet.journal.model.JournalArticle updateArticle(HttpPrincipal httpPrincipal,
                                                                             long groupId,
                                                                             java.lang.String articleId,
                                                                             double version,
                                                                             boolean incrementVersion,
                                                                             java.lang.String content)
                                                                      throws com.liferay.portal.PortalException,
                                                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateArticle

public static com.liferay.portlet.journal.model.JournalArticle updateArticle(HttpPrincipal httpPrincipal,
                                                                             long groupId,
                                                                             java.lang.String articleId,
                                                                             double version,
                                                                             boolean incrementVersion,
                                                                             java.lang.String title,
                                                                             java.lang.String description,
                                                                             java.lang.String content,
                                                                             java.lang.String type,
                                                                             java.lang.String structureId,
                                                                             java.lang.String templateId,
                                                                             int displayDateMonth,
                                                                             int displayDateDay,
                                                                             int displayDateYear,
                                                                             int displayDateHour,
                                                                             int displayDateMinute,
                                                                             int expirationDateMonth,
                                                                             int expirationDateDay,
                                                                             int expirationDateYear,
                                                                             int expirationDateHour,
                                                                             int expirationDateMinute,
                                                                             boolean neverExpire,
                                                                             int reviewDateMonth,
                                                                             int reviewDateDay,
                                                                             int reviewDateYear,
                                                                             int reviewDateHour,
                                                                             int reviewDateMinute,
                                                                             boolean neverReview,
                                                                             boolean indexable,
                                                                             boolean smallImage,
                                                                             java.lang.String smallImageURL,
                                                                             java.io.File smallFile,
                                                                             java.util.Map<java.lang.String,byte[]> images,
                                                                             java.lang.String articleURL,
                                                                             com.liferay.portal.service.ServiceContext serviceContext)
                                                                      throws com.liferay.portal.PortalException,
                                                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateContent

public static com.liferay.portlet.journal.model.JournalArticle updateContent(HttpPrincipal httpPrincipal,
                                                                             long groupId,
                                                                             java.lang.String articleId,
                                                                             double version,
                                                                             java.lang.String content)
                                                                      throws com.liferay.portal.PortalException,
                                                                             com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException