atg.projects.store.droplet

Class EndecaDocumentLinksDroplet

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.seo.ItemLink

atg.repository.seo.CanonicalItemLink

atg.projects.store.droplet.DocumentLinksDroplet

atg.projects.store.droplet.EndecaDocumentLinksDroplet

All Implemented Interfaces:

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

public class EndecaDocumentLinksDroplet
extends DocumentLinksDroplet

This is an Endeca extension of DocumentLinksDroplet that enables document link generation for Endeca driven pages.

This extended droplet takes the following optional extra input parameter:

canonicalLink

A canonical link that will be most likely be retrieved from the rootContentItem. This could be null, for example, if on a non-Endeca driven page.

Example:

     <dsp:droplet name="DocumentLinksDroplet"
                        currentCategory="${currentCategory}"
                        currentProduct="${currentProduct}"
                        currentSiteId="${siteId}"
                        canonicalLink="${canonicalLink}"
                        var="linkDetails">
       <dsp:oparam name="output">
                       
         <c:choose>
           <c:when test="${linkDetails.rel == 'alternate'}">                           
             <link rel="${linkDetails.rel}" 
                   lang="${linkDetails.lang}" 
                   hreflang="${linkDetails.hreflang}" 
                   href="${httpServer}${linkDetails.href}"/>
           </c:when>
           <c:otherwise>
             <link rel="${linkDetails.rel}" 
                   href="${httpServer}${linkDetails.href}"/>
            </c:otherwise>
         </c:choose>    
       </dsp:oparam>    
     </dsp:droplet>
   

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/Endeca/Assembler/src/atg/projects/store/droplet/EndecaDocumentLinksDroplet.java#1 $$Change: 1385662 $

Author:

Oracle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CANONICAL_LINK The Endeca generated canonical link parameter.
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.projects.store.droplet.DocumentLinksDroplet

CURRENT_CATEGORY, CURRENT_PRODUCT, CURRENT_SITE_ID, HREF, HREFLANG, ITEM, LANG, LOCALE, PRODUCT_REPOSITORY_NAME, REL

Fields inherited from class atg.repository.seo.ItemLink

mItemDescriptorToNameMap, S_EMPTY, S_ERROR, S_ERROR_MESSAGE, S_ID, S_ITEM, S_ITEM_DESCRIPTOR_NAME, S_OUTPUT, S_REPOSITORY, S_REPOSITORY_NAME, S_SITE_ID, S_URL

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
EndecaDocumentLinksDroplet()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getCanonicalLink(java.lang.Object pItem, atg.servlet.DynamoHttpServletRequest pRequest) This method gets the canonical link for Endeca driven categories.
atg.commerce.catalog.CatalogTools	getCatalogTools()
atg.commerce.endeca.cache.DimensionValueCacheTools	getDimensionValueCacheTools()
java.lang.String	getNavigationActionPath()
java.lang.String	removeParametersFromUrl(java.lang.String pUrl) Remove all parameters from the passed in URL i.e.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) See EndecaDocumentLinksDroplet for service details.
void	setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)
void	setDimensionValueCacheTools(atg.commerce.endeca.cache.DimensionValueCacheTools pDimensionValueCacheTools)
void	setNavigationActionPath(java.lang.String pNavigationActionPath)

Methods inherited from class atg.projects.store.droplet.DocumentLinksDroplet

getCatalogNavHistory, getDocumentLinksService, getRequestLocale, getSite, getSiteURLManager, getValidators, setCatalogNavHistory, setDocumentLinksService, setRequestLocale, setSite, setSiteURLManager, setValidators

Methods inherited from class atg.repository.seo.CanonicalItemLink

doStartService, getItemDescriptorNameToUrlTemplateMap, getTemplate, getTemplateMapper, setItemDescriptorNameToUrlTemplateMap

Methods inherited from class atg.repository.seo.ItemLink

getBestFitTemplateMapper, getDefaultItemDescriptorName, getDefaultRepository, getDefaultWebApp, getItemDescriptorName, getItemDescriptorNameToMapperMap, getItemLookup, getRepositoryName, getSiteLookup, getSiteManager, getSpaceMapping, populateParams, populateParams, setDefaultItemDescriptorName, setDefaultRepository, setDefaultWebApp, setItemDescriptorNameToMapperMap, setSiteManager, setSpaceMapping

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, 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

CANONICAL_LINK

public static final java.lang.String CANONICAL_LINK

The Endeca generated canonical link parameter.

See Also:

Constant Field Values

Constructor Detail

EndecaDocumentLinksDroplet

public EndecaDocumentLinksDroplet()

Method Detail

getDimensionValueCacheTools

public atg.commerce.endeca.cache.DimensionValueCacheTools getDimensionValueCacheTools()

Returns:

The DimensionValueCacheTools component.

setDimensionValueCacheTools

public void setDimensionValueCacheTools(atg.commerce.endeca.cache.DimensionValueCacheTools pDimensionValueCacheTools)

Parameters:

The - DimensionValueCacheTools component.

getCatalogTools

public atg.commerce.catalog.CatalogTools getCatalogTools()

Returns:

The CatalogTools component.

setCatalogTools

public void setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)

Parameters:

The - CatalogTools component.

getNavigationActionPath

public java.lang.String getNavigationActionPath()

Returns:

The NavigationActionPath value. This will represent an Endeca driven category page.

setNavigationActionPath

public void setNavigationActionPath(java.lang.String pNavigationActionPath)

Parameters:

The - NavigationActionPath value. This will represent an Endeca driven category page.

service

public void service(atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

See EndecaDocumentLinksDroplet for service details.

Overrides:

service in class DocumentLinksDroplet

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.

getCanonicalLink

protected java.lang.String getCanonicalLink(java.lang.Object pItem,
                                            atg.servlet.DynamoHttpServletRequest pRequest)

This method gets the canonical link for Endeca driven categories. Otherwise the canonical link is retrieved from the super.getCanonicalLink method.

Overrides:

getCanonicalLink in class DocumentLinksDroplet

Parameters:

pItem - The item for which the canonical link will be generated.

pRequest - The HTTP request.

Returns:

The Endeca/ATG driven category canonical link for pItem, otherwise null.

removeParametersFromUrl

public java.lang.String removeParametersFromUrl(java.lang.String pUrl)

Remove all parameters from the passed in URL i.e. everything after the '?' delimiter.

Parameters:

pUrl - The URL that will have all parameters removed from.

Returns:

The modified URL that will contain no parameters.