atg.service.jaxrs.restresources

Class AbstractItemLookupRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.restresources.AbstractItemLookupRestResource

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

Direct Known Subclasses:

AbstractCatalogRestResource, ArticleRestResource, MediaContentRestResource

public abstract class AbstractItemLookupRestResource
extends GenericService

This class is a common class to assist in rest endpoint data retrieval. Items using the item lookup droplet can be retrieved in a generic way.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COLLECTION_MISSING_INPUT_PARAMS
static java.lang.String	COLLECTION_PARENT_ITEM_NOT_FOUND
static java.lang.String	COLLECTION_PARENT_REPOSITORY_NOT_FOUND
static java.lang.String	COLLECTION_PROPERTY_INVALID
static java.lang.String	COLLECTION_PROPERTY_NOT_FOUND
static int	COLLECTION_SORT_SIZE
static java.lang.String	COMMA
static int	DEFAULT_PAGE_SIZE
static java.lang.String	ID
static java.lang.String	INVALID_QUERY_PARAMS
static java.lang.String	ITEM
static java.lang.String	ITEM_DESCRIPTOR_NOT_SUPPLIED
static java.lang.String	ITEM_NOT_FOUND
protected java.util.Map<java.lang.String,java.lang.String>	mEmbeddedRelationshipToResourceId
protected Repository	mRepository The repository.
static java.lang.String	PARENT_ITEM_ID
static java.lang.String	PARENT_ITEM_TYPE
static java.lang.String	PARENT_PROPERTY_NAME
static java.lang.String	REQUEST_DATA_KEY_PREFIX
protected static java.lang.String	RESOURCE_NAME
static java.lang.String	SEPARATOR
protected static java.util.ResourceBundle	sResourceBundle The resource bundle.
static java.lang.String	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
AbstractItemLookupRestResource()

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedCollectionResource(RepresentationModel.Builder pBuilder, java.lang.String pParentItemId, java.lang.String pParentItemType, java.lang.String pParentPropertyName, java.lang.String pEmbeddedResourceId, java.lang.String pEmbeddedRelationshipName) Embed the collection link to the resource passed in using the relationship name passed in.
void	addEmbeddedCollectionResources(RepresentationModel.Builder pBuilder, java.lang.String pParentItemId, java.lang.String pParentItemType) Builds embedded collection relationship links using the embeddedRelationshipToResourceId property.
java.util.Map<java.lang.String,java.lang.Object>	buildInputs(java.lang.String pItemId, java.lang.Boolean pFilterBySiteFlag, java.lang.String pSiteId) Helps method to build the inputs.
protected java.lang.String	generateRequestDataKey(java.lang.String pParentItemId, java.lang.String pParentItemType) Generate the key to use for the request data map for input and retrieval.
int	getCollectionSortLimit() Returns the collection sort limit value.
int	getDefaultLimit() Returns the default limit to use for paging if no 'limit' param set
javax.servlet.Servlet	getDroplet() Gets the droplet.
java.util.Map<java.lang.String,java.lang.String>	getEmbeddedRelationshipToResourceId() Returns property EmbeddedRelationshipToResourceId.
RepositoryItem	getItem(java.util.Map<java.lang.String,java.lang.Object> pParams) This is a generic method that can get an item.
java.lang.String	getItemDescriptor() Returns property ItemDescriptor
protected RepositoryItem	getParentRepositoryItem(java.lang.String pParentItemId, java.lang.String pParentItemType) Retrieves the repository item for the specified type/id, either from the repository or the request data map via the key.
Repository	getRepository() Returns property Repository
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
ListingResponse<RepositoryItem>	listItems(ListingRequest pListingRequest) Return a ListingResponse list of items based on listing request.
RepresentationModel.Builder	listItems(java.lang.String pParentItemId, java.lang.String pParentItemType, java.lang.String pParentPropertyName) Generic resource collection GET that retrieves the collection via the specified item's property.
RepresentationModel.Builder	listItems(java.lang.String pParentItemId, java.lang.String pParentItemType, java.lang.String pParentPropertyName, java.lang.String pCollectionSortQuery) Generic resource collection GET that retrieves the collection via the specified item's property.
protected DropletInvoker	postInvoker(DropletInvoker pInvoker, java.util.Map<java.lang.String,java.lang.Object> pParams) It does post processing required after the droplet is invoked.
protected DropletInvoker	preInvoker(DropletInvoker pInvoker, java.util.Map<java.lang.String,java.lang.Object> pParams) It sets the inputs parameters before invoking an ItemLookupDroplet.
protected RepositoryItem	retrieveItem(DropletInvoker pInvoker) Retrieve item returned by the droplet.
protected RepositoryItem	retrieveRequestData(java.lang.String pParentItemId, java.lang.String pParentItemType) When embedding collections, the collection's parent item can be passed via the request data map.
void	setCollectionSortLimit(int pCollectionSortLimit) Sets the collection sort limit value.
void	setDefaultLimit(int pDefaultLimit) Sets the default limit to use for paging if no 'limit' param set
void	setDroplet(javax.servlet.Servlet pDroplet) Sets the droplet.
void	setEmbeddedRelationshipToResourceId(java.util.Map<java.lang.String,java.lang.String> pEmbeddedRelationshipToResourceId) Sets property EmbeddedRelationshipToResourceId.
void	setItemDescriptor(java.lang.String pItemDescriptor) Sets property ItemDescriptor
void	setRepository(Repository pRepository) Sets property Repository
protected void	validateProperty(RepositoryItem pItem, java.lang.String pPropertyName) Verify the property passed in references a collection of the expected item type.

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 java.lang.String CLASS_VERSION

Class version string

RESOURCE_NAME

protected static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

ITEM

public static final java.lang.String ITEM

See Also:

Constant Field Values

ITEM_DESCRIPTOR_NOT_SUPPLIED

public static final java.lang.String ITEM_DESCRIPTOR_NOT_SUPPLIED

See Also:

Constant Field Values

ITEM_NOT_FOUND

public static final java.lang.String ITEM_NOT_FOUND

See Also:

Constant Field Values

UNEXPECTED_ERROR

public static final java.lang.String UNEXPECTED_ERROR

See Also:

Constant Field Values

COLLECTION_MISSING_INPUT_PARAMS

public static final java.lang.String COLLECTION_MISSING_INPUT_PARAMS

See Also:

Constant Field Values

COLLECTION_PARENT_REPOSITORY_NOT_FOUND

public static final java.lang.String COLLECTION_PARENT_REPOSITORY_NOT_FOUND

See Also:

Constant Field Values

COLLECTION_PARENT_ITEM_NOT_FOUND

public static final java.lang.String COLLECTION_PARENT_ITEM_NOT_FOUND

See Also:

Constant Field Values

COLLECTION_PROPERTY_NOT_FOUND

public static final java.lang.String COLLECTION_PROPERTY_NOT_FOUND

See Also:

Constant Field Values

COLLECTION_PROPERTY_INVALID

public static final java.lang.String COLLECTION_PROPERTY_INVALID

See Also:

Constant Field Values

INVALID_QUERY_PARAMS

public static final java.lang.String INVALID_QUERY_PARAMS

See Also:

Constant Field Values

REQUEST_DATA_KEY_PREFIX

public static final java.lang.String REQUEST_DATA_KEY_PREFIX

See Also:

Constant Field Values

PARENT_ITEM_ID

public static final java.lang.String PARENT_ITEM_ID

See Also:

Constant Field Values

PARENT_ITEM_TYPE

public static final java.lang.String PARENT_ITEM_TYPE

See Also:

Constant Field Values

PARENT_PROPERTY_NAME

public static final java.lang.String PARENT_PROPERTY_NAME

See Also:

Constant Field Values

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

COMMA

public static final java.lang.String COMMA

See Also:

Constant Field Values

COLLECTION_SORT_SIZE

public static final int COLLECTION_SORT_SIZE

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

The resource bundle.

mRepository

protected Repository mRepository

The repository.

mEmbeddedRelationshipToResourceId

protected java.util.Map<java.lang.String,java.lang.String> mEmbeddedRelationshipToResourceId

Constructor Detail

AbstractItemLookupRestResource

public AbstractItemLookupRestResource()

Method Detail

getDroplet

public javax.servlet.Servlet getDroplet()

Gets the droplet.

Returns:

the droplet

setDroplet

public void setDroplet(javax.servlet.Servlet pDroplet)

Sets the droplet.

Parameters:

pDroplet - the new droplet

setRepository

public void setRepository(Repository pRepository)

Sets property Repository

getRepository

public Repository getRepository()

Returns property Repository

setItemDescriptor

public void setItemDescriptor(java.lang.String pItemDescriptor)

Sets property ItemDescriptor

getItemDescriptor

public java.lang.String getItemDescriptor()

Returns property ItemDescriptor

getCollectionSortLimit

public int getCollectionSortLimit()

Returns the collection sort limit value. Collections over this limit that require sorting will be retrieved via RQL query to do the sorting in order to improve performance for larger collections.

Returns:

the limit

setCollectionSortLimit

public void setCollectionSortLimit(int pCollectionSortLimit)

Sets the collection sort limit value. Collections over this limit that require sorting will be retrieved via RQL query to do the sorting in order improve performance for larger collections.

Parameters:

pCollectionSortLimit - the limit to set

getDefaultLimit

public int getDefaultLimit()

Returns the default limit to use for paging if no 'limit' param set

Returns:

the limit

setDefaultLimit

public void setDefaultLimit(int pDefaultLimit)

Sets the default limit to use for paging if no 'limit' param set

Parameters:

pDefaultLimit - the limit to set

setEmbeddedRelationshipToResourceId

public void setEmbeddedRelationshipToResourceId(java.util.Map<java.lang.String,java.lang.String> pEmbeddedRelationshipToResourceId)

Sets property EmbeddedRelationshipToResourceId. Used to build embedded resource relationship links.

Parameters:

pEmbeddedRelationshipToResourceId - the EmbeddedRelationshipToResourceId property.

getEmbeddedRelationshipToResourceId

public java.util.Map<java.lang.String,java.lang.String> getEmbeddedRelationshipToResourceId()

Returns property EmbeddedRelationshipToResourceId. Used to build embedded resource relationship links.

Returns:

the EmbeddedRelationshipToResourceId property value.

listItems

public ListingResponse<RepositoryItem> listItems(ListingRequest pListingRequest)
                                          throws RestException,
                                                 RepositoryException,
                                                 javax.servlet.ServletException

Return a ListingResponse list of items based on listing request. The listing request can be built using the RestContext and passed it to this method. The listing request can contain inputs as i.e. startIndex, range and sorting etc.

Parameters:

pListingRequest - the listing request

Returns:

the items

Throws:

RestException - the rest exception

RepositoryException - the repository exception

javax.servlet.ServletException - the servlet exception

listItems

public RepresentationModel.Builder listItems(java.lang.String pParentItemId,
                                             java.lang.String pParentItemType,
                                             java.lang.String pParentPropertyName)
                                      throws RestException,
                                             RepositoryException,
                                             javax.servlet.ServletException

Generic resource collection GET that retrieves the collection via the specified item's property. Supports pagination, e.g. offset & limit. For performance the item may be passed via the request data map. For sorting collections when the collection sort limit is exceeded a referenced by query will be built based on the parent item.

Parameters:

pParentItemId - the id of the item that contains the collection.

pParentItemType - the repository type of the item that contains the collection, supports a qualifying repository e.g. repositoryPath:type.

pParentPropertyName - the property name containing the item collection, supports dot notation for the collection to be displayed.

Returns:

a representation model builder containing the ListingResponse and paged members.

Throws:

RestException - the rest exception

RepositoryException - the repository exception

javax.servlet.ServletException - the servlet exception

listItems

public RepresentationModel.Builder listItems(java.lang.String pParentItemId,
                                             java.lang.String pParentItemType,
                                             java.lang.String pParentPropertyName,
                                             java.lang.String pCollectionSortQuery)
                                      throws RestException,
                                             RepositoryException,
                                             javax.servlet.ServletException

Generic resource collection GET that retrieves the collection via the specified item's property. Supports pagination, e.g. offset & limit. For performance the item may be passed via the request data map. If a collection sort query is specified it will be used.

Parameters:

pParentItemId - the id of the item that contains the collection.

pParentItemType - the repository type of the item that contains the collection, supports a qualifying repository e.g. repositoryPath:type

pParentPropertyName - the property name containing the item collection, supports dot notation for the collection to be displayed.

pCollectionSortQuery - the RQL query used to retrieve a sorted collection.

Returns:

a representation model builder containing the ListingResponse and paged members.

Throws:

RestException - the rest exception

RepositoryException - the repository exception

javax.servlet.ServletException - the servlet exception

See Also:

getParentRepositoryItem(java.lang.String, java.lang.String), ListingRequest, ListingRequestUtils

getParentRepositoryItem

protected RepositoryItem getParentRepositoryItem(java.lang.String pParentItemId,
                                                 java.lang.String pParentItemType)
                                          throws RestException

Retrieves the repository item for the specified type/id, either from the repository or the request data map via the key. When retrieving from the repository we assume is the item is in the same repository as the collection, unless the type param passes a qualifying repository

Parameters:

pParentItemId - the id of the item to retrieve.

pParentItemType - the repository type of the item to retrieve, supports a qualifying repository e.g. /atg/multisite/SiteRepository:touchpoint

Returns:

the parent repository item

Throws:

RestException - the rest exception

RepositoryException - the repository exception

See Also:

retrieveRequestData(java.lang.String, java.lang.String)

retrieveRequestData

protected RepositoryItem retrieveRequestData(java.lang.String pParentItemId,
                                             java.lang.String pParentItemType)

When embedding collections, the collection's parent item can be passed via the request data map. This is for performance, you have the item there's no point in querying the repository again. Each resource will have its own key generateRequestDataKey(String pParentItemId, String pParentItemType) that can be used to place and retrieve it from the map. Retrieving the item from the request data map can be overridden via this method.

Parameters:

pParentItemId - the id of the item that contains the child collection.

pParentItemType - the parent item type.

Throws:

RestException - the rest exception

See Also:

generateRequestDataKey(java.lang.String, java.lang.String)

generateRequestDataKey

protected java.lang.String generateRequestDataKey(java.lang.String pParentItemId,
                                                  java.lang.String pParentItemType)

Generate the key to use for the request data map for input and retrieval.

To generate the key append the parent item's type to a const value.

This will be used to ensure the right key is used per resource. Using a commerce example to illustrate, if embedding category's child products the collection will be product but parent will be category, so it's the category item that's in the request data map alternatively if embedding product's related products it will be the product item in the map

If the parent item is the same type as the collection there may be a recursive issue retrieving the item adding on the id solves this issue - if this is this case we need to add the id to the key.

Parameters:

pParentItemId - the id of the item that contains the child collection.

pParentItemType - the parent item type.

Throws:

RestException - the rest exception

validateProperty

protected void validateProperty(RepositoryItem pItem,
                                java.lang.String pPropertyName)
                         throws RestException,
                                RepositoryException

Verify the property passed in references a collection of the expected item type.

Parameters:

pItem - the parent item containing the collection

pPropertyName - the name of the property referencing the collection

Throws:

RestException - the rest exception

RepositoryException

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

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

Parameters:

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

Returns:

RepresentationModel.Builder containing the state

addEmbeddedCollectionResource

public void addEmbeddedCollectionResource(RepresentationModel.Builder pBuilder,
                                          java.lang.String pParentItemId,
                                          java.lang.String pParentItemType,
                                          java.lang.String pParentPropertyName,
                                          java.lang.String pEmbeddedResourceId,
                                          java.lang.String pEmbeddedRelationshipName)

Embed the collection link to the resource passed in using the relationship name passed in. Pass through the parent repository id, parent item type and name as query params to the uri created so a valid collection uri is created for the child collection.

Parameters:

pBuilder - the model builder used to embed the link.

pParentItemId - the id of the parent item that contains the child collection.

pParentItemType - the parent item type.

pParentPropertyName - the property name.

pEmbeddedResourceId - the id of the rest resource to be embedded.

pEmbeddedRelationshipName - the name of the embedded relationship.

addEmbeddedCollectionResources

public void addEmbeddedCollectionResources(RepresentationModel.Builder pBuilder,
                                           java.lang.String pParentItemId,
                                           java.lang.String pParentItemType)

Builds embedded collection relationship links using the embeddedRelationshipToResourceId property.

Parameters:

pBuilder - the representation model builder.

pParentItemId - the parent item repository id.

pParentItemType - the parent item type.

getItem

public RepositoryItem getItem(java.util.Map<java.lang.String,java.lang.Object> pParams)
                       throws RestException

This is a generic method that can get an item. It uses the ItemLookupDropletName setting to determine which droplet gets referenced. The useParams property of this droplet needs to be set to true for the filter flags to be used. Otherwise the filter flags will be ignored. The FilterBySiteFlag will filter by the siteId. If siteId is not set it will filter by the current site context.

Parameters:

pParams - the params

Returns:

the item

Throws:

RestException - the rest exception

preInvoker

protected DropletInvoker preInvoker(DropletInvoker pInvoker,
                                    java.util.Map<java.lang.String,java.lang.Object> pParams)

It sets the inputs parameters before invoking an ItemLookupDroplet. This method can be overridden to add any extra parameters requires for droplet.

Parameters:

pInvoker - the invoker

pParams - the params

Returns:

the droplet invoker

postInvoker

protected DropletInvoker postInvoker(DropletInvoker pInvoker,
                                     java.util.Map<java.lang.String,java.lang.Object> pParams)
                              throws RestException

It does post processing required after the droplet is invoked. This method can be overridden to add any further processing requires for droplet.

Parameters:

pInvoker - the invoker

pParams - the params

Returns:

the droplet invoker

Throws:

RestException - the rest exception

retrieveItem

protected RepositoryItem retrieveItem(DropletInvoker pInvoker)

Retrieve item returned by the droplet. This method can be used to override the params used to retrieve the item

Parameters:

pInvoker - the invoker

Returns:

the item returned by the droplet

Throws:

RestException - the rest exception

buildInputs

public java.util.Map<java.lang.String,java.lang.Object> buildInputs(java.lang.String pItemId,
                                                                    java.lang.Boolean pFilterBySiteFlag,
                                                                    java.lang.String pSiteId)

Helps method to build the inputs.

Parameters:

pItemId - the item id

pFilterBySiteFlag - the filter by site flag

pSiteId - the site id

Returns:

the map