atg.content.restresources

Class ArticleRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.restresources.AbstractItemLookupRestResource

atg.content.restresources.ArticleRestResource

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

@RestResource(id=<error>)
public class ArticleRestResource
extends AbstractItemLookupRestResource

This class represents an article resource. It helps in providing individual article based on article id or collection of articles based on a parent item. For collection articles the article is identified by providing the articles parent item id, type and property name through query parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.service.jaxrs.restresources.AbstractItemLookupRestResource

COLLECTION_MISSING_INPUT_PARAMS, COLLECTION_PARENT_ITEM_NOT_FOUND, COLLECTION_PARENT_REPOSITORY_NOT_FOUND, COLLECTION_PROPERTY_INVALID, COLLECTION_PROPERTY_NOT_FOUND, COLLECTION_SORT_SIZE, COMMA, DEFAULT_PAGE_SIZE, ID, INVALID_QUERY_PARAMS, ITEM, ITEM_DESCRIPTOR_NOT_SUPPLIED, ITEM_NOT_FOUND, mEmbeddedRelationshipToResourceId, mRepository, PARENT_ITEM_ID, PARENT_ITEM_TYPE, PARENT_PROPERTY_NAME, REQUEST_DATA_KEY_PREFIX, RESOURCE_NAME, SEPARATOR, sResourceBundle, UNEXPECTED_ERROR

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
ArticleRestResource()

Method Summary

Modifier and Type	Method and Description
RepresentationModel	getArticle(java.lang.String pArticleId, java.lang.Boolean pFilterBySiteFlag, java.lang.String pSiteId) Get the article matching the id passed.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState, java.lang.String pItemId) Gets the RepresentationModel.Builder with the given object acting as the state.
RepresentationModel	listArticles(java.lang.String pParentItemId, java.lang.String pParentItemType, java.lang.String pParentPropertyName, java.lang.String pOffset, java.lang.String pLimit, java.lang.String pOrderBy) Gets the collection of articles based on parentItemId, parentItemType and parentPropertyName query parameters.

Methods inherited from class atg.service.jaxrs.restresources.AbstractItemLookupRestResource

addEmbeddedCollectionResource, addEmbeddedCollectionResources, buildInputs, generateRequestDataKey, getCollectionSortLimit, getDefaultLimit, getDroplet, getEmbeddedRelationshipToResourceId, getItem, getItemDescriptor, getParentRepositoryItem, getRepository, getRepresentationModelBuilder, listItems, listItems, listItems, postInvoker, preInvoker, retrieveItem, retrieveRequestData, setCollectionSortLimit, setDefaultLimit, setDroplet, setEmbeddedRelationshipToResourceId, setItemDescriptor, setRepository, validateProperty

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ArticleRestResource

public ArticleRestResource()

Method Detail

listArticles

@Endpoint(id="/articles/#GET",
          isSingular=false,
          filterId="articles-Default")
public RepresentationModel listArticles(java.lang.String pParentItemId,
                                                                                                                                          java.lang.String pParentItemType,
                                                                                                                                          java.lang.String pParentPropertyName,
                                                                                                                                          java.lang.String pOffset,
                                                                                                                                          java.lang.String pLimit,
                                                                                                                                          java.lang.String pOrderBy)
                                                                                                                                   throws RestException,
                                                                                                                                          RepositoryException,
                                                                                                                                          javax.servlet.ServletException

Gets the collection of articles based on parentItemId, parentItemType and parentPropertyName query parameters.

The collection will be paged. Paging can be controlled using the offset & limit query parameters. If no limit is set the resource's defaultLimit will be used.

The collection order may be controlled using the orderBy param. Format is orderBy=propertyName:asc|desc. Supports a comma separated set of properties.

Parameters:

pParentItemId - The parent item id of the articles to return.

pParentItemType - The parent item type of the articles to return.

pParentPropertyName - The parent item property name that references the articles to return

pOffset - The page start index

pLimit - The page size

pOrderBy - The repository item properties to sort results by. Direction defaults to ascending.

Returns:

the articles

Throws:

RestException - the rest exception

RepositoryException - the repository exception

javax.servlet.ServletException - the servlet exception

getArticle

@Endpoint(id="/articles/{articleId}#GET",
          isSingular=true,
          filterId="articles.id-Default")
public RepresentationModel getArticle(java.lang.String pArticleId,
                                                                                                                                                     java.lang.Boolean pFilterBySiteFlag,
                                                                                                                                                     java.lang.String pSiteId)
                                                                                                                                              throws RestException,
                                                                                                                                                     RepositoryException

Get the article matching the id passed. It will automatically use the user's locale for alternate repositories if defined.

Parameters:

pArticleId - the id of the article to find

pFilterBySiteFlag - if true only find the article if it matches siteId or the current site context

pSiteId - site id article should belong to. If not set current site will be used.

Returns:

the model containing the article and state details

Throws:

RestException - the rest exception

RepositoryException - if fails to retrieve article repository item

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState,
                                                                    java.lang.String pItemId)

Gets the RepresentationModel.Builder with the given object acting as the state.

Also embeds articles.

Parameters:

pState - the state that will be added to the representation model

pItemId - the item repository id

Returns:

RepresentationModel.Builder containing the state and embedded resources