ItemLookupDroplet (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.GenericService
  - - atg.nucleus.TimedOperationService
    - - atg.nucleus.servlet.ServletService
      - atg.nucleus.servlet.HttpServletService
        
        atg.servlet.DynamoServlet
        
        atg.repository.servlet.ItemLookupDroplet

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, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

Direct Known Subclasses:

CatalogItemLookupDroplet
```
public class ItemLookupDroplet
extends DynamoServlet
```
This servlet looks for a RepositoryItem by its id from within a Repository. If the item is found, output is rendered. If the item is not found empty is rendered. If property filterBySite is true or filterBySite param is true, found item will be filtered by the item's "sites" property. If the item is not accessible in the current site, wrongSite is rendered.
The repository and item descriptor type can be configured through properties. If the useParams property is true, then the repository and item descriptor can be resolved through input parameters. One can configure this droplet to define a mapping from a key to an alternate set of repositories.
For example: ProductLookup.properties
```
 $class=atg.repository.servlet.ItemLookupDroplet
 
 repository=/atg/commerce/catalog/ProductCatalog
 itemDescriptor=product
 
 alternateRepositories=\
      fr_FR=/atg/commerce/catalog/FrenchProductCatalog
      ja_JP=/atg/commerce/catalog/JapaneseProductCatalog
      de_DE=/atg/commerce/catalog/GermanProductCatalog
 
```
The invocation of the droplet can then be invoked with the following parameters:
```
  <dsp:droplet name="/atg/commerce/catalog/ProductLookup">
    <dsp:param name="id" param="productId"/>
    <dsp:param  name="repositoryKey" bean="/OriginatingRequest.requestLocale.localeString"/>
    <dsp:setvalue param="product" paramvalue="element"/>
    <dsp:oparam name="output">
       <dsp:getvalueof id="a11" param="product.template.url" idtype="java.lang.String">
         <dsp:a href="<%=a11%>">
            <dsp:param name="prod_id" param="product.repositoryId"/>
            <dsp:valueof param="product.displayName"/>
         </dsp:a>
       </dsp:getvalueof>
    </dsp:oparam>
  </dsp:droplet>
 
```
If the mapping for the provided key is found that repository will be used, otherwise the system will fall back to the default repository and search for the item.
If the item cannot be found in the repository searched (e.g. the french product catalog), then the droplet will once again fall back to the default repository and attempt to find the item using the same id. Obviously this is only useful if the items have the exact same id in each repository.
In this example if you are french and attempt to look at product 1234, and product 1234 is defined in the french product catalog you will see that item. However if 1234 is not defined then you will see the default english version of 1234.
This behavior can be modified with use of the useDefaultRepository and getDefaultItem properties. If useDefaultRepository is false and an alternate repository cannot be found, then no repository is searched and empty is serviced. Like wise, if an alternative repository is selected, but the item cannot be found, and if getDefaultItem is false, then the default repository will not be searched and empty will be serviced.
The required input paramters for this servlet are:

id
The id of the item to lookup
The following parameters are optional:

repositoryKey
If specified this parameter will be used as a key to map to a secondary set of repositories.
elementName
This parameter can be used to change the default name of the element which is bound into the scope of the output oparam.
repository
The repository within which to look for the item. It is recommended to not use this parameter and to define different instances of the ItemLookupDroplet for each set of repositories you wish to use.
itemDescriptor
The name of the Item Descriptor to use to load the item. It is recommended to not use this parameter and to setup the item descriptor through property configuration.
siteIds
The sites to look for the item in, by string id rather than object. If you want to search in a site other than the current site explicitly provide the site id(s). Example use case, shopping cart contains commerceItems from another site and you want to display the item's product details page, filter product using the commerce item's site id. The siteIds parameter supercedes sites. The item must be a member of at least one of the site ids given. This must be a Collection of Strings.
sites
The sites to look for the item in. This is normally not needed since the current site will be used. If however, you want to search in a site other than the current site, or there is no current session (for example within the context of an email template) then you may want to explicitly provide the site. If you provide more than one site, the item must be a member of at least one of the sites. This must be a Collection of Site objects. The sites parameter will only be used if siteIds parameter is not set.
filterBySite
Whether or not the item should match the specified site(s) or siteId(s). If set to false then the item will not be checked against any site. If set to true but sites or siteIds are not specified match against current site context if it is set.

The following parameters are rendered:

output
Rendered if the item was found in the repository
empty
Rendered in all other cases, e.g. item not found, user did not specify a required parameter.
The output parameters for this servlet are:

element
Set to the RepositoryItem corresponding to the id supplied
error
Any exception that may have occured while looking up the item
wrongSite
This gets rendered if the item being looked up is not accessible through the current user's site.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`static java.lang.String`	`ELEMENT`
`static java.lang.String`	`ELEMENT_NAME_STR`
`static java.lang.String`	`EMPTY_OPARAM`
`static java.lang.String`	`ERROR`
`static java.lang.String`	`FILTER_BY_SITE`
`protected static ParameterName`	`FILTER_BY_SITE_PARAM`
`static java.lang.String`	`ID`
`static java.lang.String`	`ITEM_DESC`
`static java.lang.String`	`OUTPUT_OPARAM`
`static java.lang.String`	`REPOSITORY`
`static java.lang.String`	`REPOSITORY_KEY`
`protected static ParameterName`	`SITE_IDS_PARAM`
`static java.lang.String`	`SITEIDS`
`static java.lang.String`	`SITES`
`protected static ParameterName`	`SITES_PARAM`
`static java.lang.String`	`WRONG_SITE_OPARAM`

Fields inherited from class atg.servlet.DynamoServlet
mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService
SERVLET_INFO_KEY

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

ItemLookupDroplet()

Constructors
Constructor and Description
`ItemLookupDroplet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`commitTransaction(javax.transaction.Transaction pTransaction)` Commits the supplied transaction
`protected javax.transaction.Transaction`	`ensureTransaction()` This method ensures that a transaction exists before returning.
`ServiceMap`	`getAlternateRepositories()` Returns property AlternateRepositories
`java.lang.String`	`getItemDescriptor()` Returns property ItemDescriptor
`Repository`	`getRepository()` Returns property Repository
`protected java.util.Collection<java.lang.String>`	`getSiteIds(DynamoHttpServletRequest pRequest)` If we have collection of site ids in request parameter, then returns them, otherwise returns `null`.
`protected java.util.Collection<Site>`	`getSites(DynamoHttpServletRequest pRequest)` If we have collection of sites in request parameter, then returns them, otherwise returns `null`.
`java.lang.String`	`getSitesPropertyName()` Returns property SitesPropertyName
`javax.transaction.TransactionManager`	`getTransactionManager()` Returns property TransactionManager.
`boolean`	`isEnsureTransaction()` Returns property EnsureTransaction
`boolean`	`isFilterBySite()` Returns property FilterBySite
`boolean`	`isFilterBySite(DynamoHttpServletRequest pRequest)` Determines if we are filtering by sites.
`boolean`	`isGetDefaultItem()` Returns property GetDefaultItem
`protected boolean`	`isItemInSites(java.util.Collection<Site> pSites, java.util.Collection<java.lang.String> pItemSites, java.util.Collection<java.lang.String> pItemSiteIdsResolved)` Determines if an item belongs to any of the given set of sites or the current site.
`boolean`	`isItemInSites(RepositoryItem pItem, java.util.Collection<Site> pSites)` Determines if a given item is a part of any sites from the given set or the current site.
`boolean`	`isItemInSites(RepositoryItem pItem, java.util.Collection<Site> pSites, java.util.Collection<java.lang.String> pSiteIds)` Determines if a given item is a part of the given sets or the current site.
`boolean`	`isUseDefaultRepository()` Returns property UseDefaultRepository
`boolean`	`isUseParams()` Returns property UseParams
`protected java.util.Collection<java.lang.String>`	`retrieveItemSites(RepositoryItem pItem)` Calculates given item site ids, looking in the item's sitesPropertyName property If the item's site property doesn't exists then check the item descriptor's context membership, e.g.
`void`	`service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Look for the RepositoryItem and if found render the output oparam by binding the item as a parameter.
`void`	`setAlternateRepositories(ServiceMap pAlternateRepositories)` Sets property AlternateRepositories
`void`	`setEnsureTransaction(boolean pEnsureTransaction)` Sets property EnsureTransaction
`void`	`setFilterBySite(boolean pFilterBySite)` Sets property FilterBySite
`void`	`setGetDefaultItem(boolean pGetDefaultItem)` Sets property GetDefaultItem
`void`	`setItemDescriptor(java.lang.String pItemDescriptor)` Sets property ItemDescriptor
`void`	`setRepository(Repository pRepository)` Sets property Repository
`void`	`setSitesPropertyName(java.lang.String pSitesPropertyName)` Sets property SitesPropertyName
`void`	`setTransactionManager(javax.transaction.TransactionManager pTransactionManager)` Sets property TransactionManager
`void`	`setUseDefaultRepository(boolean pUseDefaultRepository)` Sets property UseDefaultRepository
`void`	`setUseParams(boolean pUseParams)` Sets property UseParams

Methods inherited from class atg.servlet.DynamoServlet
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService
destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

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
  - ELEMENT_NAME_STR
```
public static final java.lang.String ELEMENT_NAME_STR
```
    See Also:
    
    Constant Field Values
  - REPOSITORY
```
public static final java.lang.String REPOSITORY
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final java.lang.String ID
```
    See Also:
    
    Constant Field Values
  - REPOSITORY_KEY
```
public static final java.lang.String REPOSITORY_KEY
```
    See Also:
    
    Constant Field Values
  - ITEM_DESC
```
public static final java.lang.String ITEM_DESC
```
    See Also:
    
    Constant Field Values
  - SITES
```
public static final java.lang.String SITES
```
    See Also:
    
    Constant Field Values
  - FILTER_BY_SITE
```
public static final java.lang.String FILTER_BY_SITE
```
    See Also:
    
    Constant Field Values
  - SITEIDS
```
public static final java.lang.String SITEIDS
```
    See Also:
    
    Constant Field Values
  - SITES_PARAM
```
protected static final ParameterName SITES_PARAM
```
  - FILTER_BY_SITE_PARAM
```
protected static final ParameterName FILTER_BY_SITE_PARAM
```
  - SITE_IDS_PARAM
```
protected static final ParameterName SITE_IDS_PARAM
```
  - ELEMENT
```
public static final java.lang.String ELEMENT
```
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final java.lang.String ERROR
```
    See Also:
    
    Constant Field Values
  - OUTPUT_OPARAM
```
public static final java.lang.String OUTPUT_OPARAM
```
    See Also:
    
    Constant Field Values
  - EMPTY_OPARAM
```
public static final java.lang.String EMPTY_OPARAM
```
    See Also:
    
    Constant Field Values
  - WRONG_SITE_OPARAM
```
public static final java.lang.String WRONG_SITE_OPARAM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ItemLookupDroplet
```
public ItemLookupDroplet()
```
- Method Detail
  - 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
  - setAlternateRepositories
```
public void setAlternateRepositories(ServiceMap pAlternateRepositories)
```
    Sets property AlternateRepositories
  - getAlternateRepositories
```
public ServiceMap getAlternateRepositories()
```
    Returns property AlternateRepositories
  - setTransactionManager
```
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
```
    Sets property TransactionManager
  - getTransactionManager
```
public javax.transaction.TransactionManager getTransactionManager()
```
    Returns property TransactionManager. If the internal transaction manager reference is null, it will be retrieved from the Repository if possible
  - setEnsureTransaction
```
public void setEnsureTransaction(boolean pEnsureTransaction)
```
    Sets property EnsureTransaction
  - isEnsureTransaction
```
public boolean isEnsureTransaction()
```
    Returns property EnsureTransaction
  - setUseParams
```
public void setUseParams(boolean pUseParams)
```
    Sets property UseParams
  - isUseParams
```
public boolean isUseParams()
```
    Returns property UseParams
  - setUseDefaultRepository
```
public void setUseDefaultRepository(boolean pUseDefaultRepository)
```
    Sets property UseDefaultRepository
  - isUseDefaultRepository
```
public boolean isUseDefaultRepository()
```
    Returns property UseDefaultRepository
  - setGetDefaultItem
```
public void setGetDefaultItem(boolean pGetDefaultItem)
```
    Sets property GetDefaultItem
  - isGetDefaultItem
```
public boolean isGetDefaultItem()
```
    Returns property GetDefaultItem
  - setFilterBySite
```
public void setFilterBySite(boolean pFilterBySite)
```
    Sets property FilterBySite
  - isFilterBySite
```
public boolean isFilterBySite()
```
    Returns property FilterBySite
  - setSitesPropertyName
```
public void setSitesPropertyName(java.lang.String pSitesPropertyName)
```
    Sets property SitesPropertyName
  - getSitesPropertyName
```
public java.lang.String getSitesPropertyName()
```
    Returns property SitesPropertyName
  - ensureTransaction
```
protected javax.transaction.Transaction ensureTransaction()
```
    This method ensures that a transaction exists before returning. If there is no transaction, a new one is started and returned. In this case, you must call commitTransaction when the transaction completes.
  - commitTransaction
```
protected void commitTransaction(javax.transaction.Transaction pTransaction)
```
    Commits the supplied transaction
  - service
```
public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException
```
    Look for the RepositoryItem and if found render the output oparam by binding the item as a parameter. If no item can be found render the empty oparam.
    
    Overrides:
    
    service in class DynamoServlet
    
    Parameters:
    
    pRequest - the request to be processed
    
    pResponse - the response object for this request
    
    Throws:
    
    javax.servlet.ServletException - an application specific error occurred processing this request
    
    java.io.IOException - an error occurred reading data from the request or writing data to the response.
  - isItemInSites
```
public boolean isItemInSites(RepositoryItem pItem,
                             java.util.Collection<Site> pSites)
```
    Determines if a given item is a part of any sites from the given set or the current site. If there is no site property to check or if the item has no sites property in its definition, return true. If sites are not set, check against current site if current site context is not set, return true. If the item has no sites return false.
    
    Parameters:
    
    pItem - repository item
    
    pSites - set of sites
    
    Returns:
    
    true if item is a part of any site.
  - isItemInSites
```
protected boolean isItemInSites(java.util.Collection<Site> pSites,
                                java.util.Collection<java.lang.String> pItemSites,
                                java.util.Collection<java.lang.String> pItemSiteIdsResolved)
```
    Determines if an item belongs to any of the given set of sites or the current site.
    
    Parameters:
    
    pSites - set of sites the item must belong to (can reference sites/site groups), if null check the current site
    
    pItemSites - set of site ids, or site group ids e.g. sg:us, the item belongs to,
    
    pItemSiteIdsResolved - full set of site ids the item belongs to
    
    Returns:
    
    true if item is in any of the sites
  - isItemInSites
```
public boolean isItemInSites(RepositoryItem pItem,
                             java.util.Collection<Site> pSites,
                             java.util.Collection<java.lang.String> pSiteIds)
```
    Determines if a given item is a part of the given sets or the current site. Check item's site(s) against siteIds if set, if not set then check against sites. If sites/siteIds are not set check against current site, if current site context is not set, return true. If the sitesPropertyName is defined but the item has no site property to check or if the sitesPropertyName is not defined but site context membership is not enabled, return true. If the item has no sites return false.
    
    Parameters:
    
    pItem - repository item
    
    pSites - set of site objects
    
    pSiteIds - set of site ids
    
    Returns:
    
    true if item is a part of any site.
  - retrieveItemSites
```
protected java.util.Collection<java.lang.String> retrieveItemSites(RepositoryItem pItem)
```
    Calculates given item site ids, looking in the item's sitesPropertyName property If the item's site property doesn't exists then check the item descriptor's context membership, e.g. using product's catalog site id. If site property name set but the property does not exist on the item or if site property name not set and context membership is not enabled then return null. If item holds no/null sites or exception occurs getting sites, return empty list. Otherwise return site id(s) or site group id(s) item belongs to.
    
    Parameters:
    
    pItem - given repository item
    
    Returns:
    
    collection of given item's site ids or group ids.
  - getSites
```
protected java.util.Collection<Site> getSites(DynamoHttpServletRequest pRequest)
```
    If we have collection of sites in request parameter, then returns them, otherwise returns null.
    
    Parameters:
    
    pRequest - Dynamo http request
    
    Returns:
    
    collection of sites or null
  - getSiteIds
```
protected java.util.Collection<java.lang.String> getSiteIds(DynamoHttpServletRequest pRequest)
```
    If we have collection of site ids in request parameter, then returns them, otherwise returns null.
    
    Parameters:
    
    pRequest - Dynamo http request
    
    Returns:
    
    string collection of site ids or null
  - isFilterBySite
```
public boolean isFilterBySite(DynamoHttpServletRequest pRequest)
```
    Determines if we are filtering by sites. Acceptable parameters are Boolean and String.
    
    Parameters:
    
    pRequest - Dynamo http request
    
    Returns:
    
    true if we filter item by site

Class ItemLookupDroplet

Field Summary

Fields inherited from class atg.servlet.DynamoServlet

Fields inherited from class atg.nucleus.servlet.ServletService

Fields inherited from class atg.nucleus.GenericService

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.servlet.DynamoServlet

Methods inherited from class atg.nucleus.servlet.ServletService

Methods inherited from class atg.nucleus.TimedOperationService

Methods inherited from class atg.nucleus.GenericService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

ELEMENT_NAME_STR

REPOSITORY

ID

REPOSITORY_KEY

ITEM_DESC

SITES

FILTER_BY_SITE

SITEIDS

SITES_PARAM

FILTER_BY_SITE_PARAM

SITE_IDS_PARAM

ELEMENT

ERROR

OUTPUT_OPARAM

EMPTY_OPARAM

WRONG_SITE_OPARAM

Constructor Detail

ItemLookupDroplet

Method Detail

setRepository

getRepository

setItemDescriptor

getItemDescriptor

setAlternateRepositories

getAlternateRepositories

setTransactionManager

getTransactionManager

setEnsureTransaction

isEnsureTransaction

setUseParams

isUseParams

setUseDefaultRepository

isUseDefaultRepository

setGetDefaultItem

isGetDefaultItem

setFilterBySite

isFilterBySite

setSitesPropertyName

getSitesPropertyName

ensureTransaction

commitTransaction

service

isItemInSites

isItemInSites

isItemInSites

retrieveItemSites

getSites

getSiteIds

isFilterBySite