com.liferay.portlet.journal.service.http
Class JournalArticleServiceHttp
java.lang.Object
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 it is generated.
Method Summary |
static JournalArticle |
addArticle(HttpPrincipal httpPrincipal,
long groupId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String type,
String structureId,
String templateId,
String layoutUuid,
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,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String type,
String structureId,
String templateId,
String layoutUuid,
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 void |
expireArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
String articleURL,
ServiceContext serviceContext)
|
static JournalArticle |
getArticle(HttpPrincipal httpPrincipal,
long id)
|
static JournalArticle |
getArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId)
|
static JournalArticle |
getArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version)
|
static JournalArticle |
getArticle(HttpPrincipal httpPrincipal,
long groupId,
String className,
long classPK)
|
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 List<JournalArticle> |
getArticlesByArticleId(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
int start,
int end,
OrderByComparator obc)
|
static List<JournalArticle> |
getArticlesByLayoutUuid(HttpPrincipal httpPrincipal,
long groupId,
String layoutUuid)
|
static int |
getArticlesCountByArticleId(HttpPrincipal httpPrincipal,
long groupId,
String articleId)
|
static JournalArticle |
getDisplayArticleByUrlTitle(HttpPrincipal httpPrincipal,
long groupId,
String urlTitle)
|
static JournalArticle |
getLatestArticle(HttpPrincipal httpPrincipal,
long resourcePrimKey)
|
static JournalArticle |
getLatestArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
int status)
|
static JournalArticle |
getLatestArticle(HttpPrincipal httpPrincipal,
long groupId,
String className,
long classPK)
|
static void |
removeArticleLocale(HttpPrincipal httpPrincipal,
long companyId,
String languageId)
|
static JournalArticle |
removeArticleLocale(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
String languageId)
|
static List<JournalArticle> |
search(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String keywords,
Double version,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
int start,
int end,
OrderByComparator obc)
|
static List<JournalArticle> |
search(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String[] structureIds,
String[] templateIds,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
|
static List<JournalArticle> |
search(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
|
static int |
searchCount(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String keywords,
Double version,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate)
|
static int |
searchCount(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String[] structureIds,
String[] templateIds,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator)
|
static int |
searchCount(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator)
|
static void |
subscribe(HttpPrincipal httpPrincipal,
long groupId)
|
static void |
unsubscribe(HttpPrincipal httpPrincipal,
long groupId)
|
static JournalArticle |
updateArticle(HttpPrincipal httpPrincipal,
long userId,
long groupId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String layoutUuid,
ServiceContext serviceContext)
|
static JournalArticle |
updateArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String type,
String structureId,
String templateId,
String layoutUuid,
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 |
updateArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
String content,
ServiceContext serviceContext)
|
static JournalArticle |
updateArticleTranslation(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images)
|
static JournalArticle |
updateArticleTranslation(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images,
ServiceContext serviceContext)
|
static JournalArticle |
updateContent(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
String content)
|
static JournalArticle |
updateStatus(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
int status,
String articleURL,
ServiceContext serviceContext)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JournalArticleServiceHttp
public JournalArticleServiceHttp()
addArticle
public static JournalArticle addArticle(HttpPrincipal httpPrincipal,
long groupId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String type,
String structureId,
String templateId,
String layoutUuid,
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,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String type,
String structureId,
String templateId,
String layoutUuid,
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
expireArticle
public static void expireArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
String articleURL,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getArticle
public static JournalArticle getArticle(HttpPrincipal httpPrincipal,
long id)
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
getArticle
public static JournalArticle getArticle(HttpPrincipal httpPrincipal,
long groupId,
String className,
long classPK)
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
getArticlesByArticleId
public static List<JournalArticle> getArticlesByArticleId(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getArticlesByLayoutUuid
public static List<JournalArticle> getArticlesByLayoutUuid(HttpPrincipal httpPrincipal,
long groupId,
String layoutUuid)
throws SystemException
- Throws:
SystemException
getArticlesCountByArticleId
public static int getArticlesCountByArticleId(HttpPrincipal httpPrincipal,
long groupId,
String articleId)
throws SystemException
- Throws:
SystemException
getDisplayArticleByUrlTitle
public static JournalArticle getDisplayArticleByUrlTitle(HttpPrincipal httpPrincipal,
long groupId,
String urlTitle)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getLatestArticle
public static JournalArticle getLatestArticle(HttpPrincipal httpPrincipal,
long resourcePrimKey)
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
getLatestArticle
public static JournalArticle getLatestArticle(HttpPrincipal httpPrincipal,
long groupId,
String className,
long classPK)
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
search
public static List<JournalArticle> search(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String keywords,
Double version,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
search
public static List<JournalArticle> search(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
search
public static List<JournalArticle> search(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String[] structureIds,
String[] templateIds,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
searchCount
public static int searchCount(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String keywords,
Double version,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate)
throws SystemException
- Throws:
SystemException
searchCount
public static int searchCount(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String structureId,
String templateId,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator)
throws SystemException
- Throws:
SystemException
searchCount
public static int searchCount(HttpPrincipal httpPrincipal,
long companyId,
long groupId,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String type,
String[] structureIds,
String[] templateIds,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator)
throws SystemException
- Throws:
SystemException
subscribe
public static void subscribe(HttpPrincipal httpPrincipal,
long groupId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
unsubscribe
public static void unsubscribe(HttpPrincipal httpPrincipal,
long groupId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateArticle
public static JournalArticle updateArticle(HttpPrincipal httpPrincipal,
long userId,
long groupId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String layoutUuid,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateArticle
public static JournalArticle updateArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String type,
String structureId,
String templateId,
String layoutUuid,
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
updateArticle
public static JournalArticle updateArticle(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
String content,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateArticleTranslation
public static JournalArticle updateArticleTranslation(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateArticleTranslation
public static JournalArticle updateArticleTranslation(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images,
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
updateStatus
public static JournalArticle updateStatus(HttpPrincipal httpPrincipal,
long groupId,
String articleId,
double version,
int status,
String articleURL,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException