Liferay 6.0.5

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

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

public class JournalArticleServiceHttp
extends Object

This class provides a HTTP utility for the 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 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:
JournalArticleServiceSoap, HttpPrincipal, JournalArticleServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
JournalArticleServiceHttp()
           
 
Method Summary
static JournalArticle addArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, boolean autoArticleId, String title, String description, String content, String type, String structureId, 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, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext)
           
static JournalArticle addArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, boolean autoArticleId, String title, String description, String content, String type, String structureId, 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, String articleURL, ServiceContext serviceContext)
           
static JournalArticle copyArticle(HttpPrincipal httpPrincipal, long groupId, String oldArticleId, String newArticleId, boolean autoArticleId, double version)
           
static void deleteArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
           
static void deleteArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, String articleURL, ServiceContext serviceContext)
           
static JournalArticle expireArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
           
static JournalArticle getArticle(HttpPrincipal httpPrincipal, long groupId, String articleId)
           
static JournalArticle getArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, double version)
           
static JournalArticle getArticleByUrlTitle(HttpPrincipal httpPrincipal, long groupId, String urlTitle)
           
static String getArticleContent(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, String languageId, ThemeDisplay themeDisplay)
           
static String getArticleContent(HttpPrincipal httpPrincipal, long groupId, String articleId, String languageId, ThemeDisplay themeDisplay)
           
static JournalArticle getLatestArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, int status)
           
static void removeArticleLocale(HttpPrincipal httpPrincipal, long companyId, String languageId)
           
static JournalArticle removeArticleLocale(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, String languageId)
           
static JournalArticle updateArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, String content)
           
static JournalArticle updateArticle(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, String title, String description, String content, String type, String structureId, 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, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext)
           
static JournalArticle updateContent(HttpPrincipal httpPrincipal, long groupId, String articleId, double version, 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 JournalArticle addArticle(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        String articleId,
                                        boolean autoArticleId,
                                        String title,
                                        String description,
                                        String content,
                                        String type,
                                        String structureId,
                                        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,
                                        String smallImageURL,
                                        File smallFile,
                                        Map<String,byte[]> images,
                                        String articleURL,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

addArticle

public static JournalArticle addArticle(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        String articleId,
                                        boolean autoArticleId,
                                        String title,
                                        String description,
                                        String content,
                                        String type,
                                        String structureId,
                                        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,
                                        String articleURL,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

copyArticle

public static JournalArticle copyArticle(HttpPrincipal httpPrincipal,
                                         long groupId,
                                         String oldArticleId,
                                         String newArticleId,
                                         boolean autoArticleId,
                                         double version)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

deleteArticle

public static void deleteArticle(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 String articleId,
                                 double version,
                                 String articleURL,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

deleteArticle

public static void deleteArticle(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 String articleId,
                                 String articleURL,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

expireArticle

public static JournalArticle expireArticle(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String articleId,
                                           double version,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getArticle

public static JournalArticle getArticle(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        String articleId)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getArticle

public static JournalArticle getArticle(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        String articleId,
                                        double version)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getArticleByUrlTitle

public static JournalArticle getArticleByUrlTitle(HttpPrincipal httpPrincipal,
                                                  long groupId,
                                                  String urlTitle)
                                           throws PortalException,
                                                  SystemException
Throws:
PortalException
SystemException

getArticleContent

public static String getArticleContent(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       String articleId,
                                       double version,
                                       String languageId,
                                       ThemeDisplay themeDisplay)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getArticleContent

public static String getArticleContent(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       String articleId,
                                       String languageId,
                                       ThemeDisplay themeDisplay)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getLatestArticle

public static JournalArticle getLatestArticle(HttpPrincipal httpPrincipal,
                                              long groupId,
                                              String articleId,
                                              int status)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

removeArticleLocale

public static void removeArticleLocale(HttpPrincipal httpPrincipal,
                                       long companyId,
                                       String languageId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

removeArticleLocale

public static JournalArticle removeArticleLocale(HttpPrincipal httpPrincipal,
                                                 long groupId,
                                                 String articleId,
                                                 double version,
                                                 String languageId)
                                          throws PortalException,
                                                 SystemException
Throws:
PortalException
SystemException

updateArticle

public static JournalArticle updateArticle(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String articleId,
                                           double version,
                                           String content)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

updateArticle

public static JournalArticle updateArticle(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String articleId,
                                           double version,
                                           String title,
                                           String description,
                                           String content,
                                           String type,
                                           String structureId,
                                           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,
                                           String smallImageURL,
                                           File smallFile,
                                           Map<String,byte[]> images,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

updateContent

public static JournalArticle updateContent(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           String articleId,
                                           double version,
                                           String content)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5