atg.projects.store.droplet
Class DisplayLanguagesDroplet

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.projects.store.droplet.DisplayLanguagesDroplet

All Implemented Interfaces:

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 DisplayLanguagesDroplet
extends atg.servlet.DynamoServlet

This droplet takes a list of language keys, and returns a list of objects associating those keys with their proper display languages. This is useful to list the available languages at the top of a page. Input Parameters: languages - Available language codes for a particular site, e.g [en,es] countryCode - The country code e.g 'US' Open Parameters: output - Serviced when there are no errors Output Parameters: currentSelection - The index of the currently selected locale in displayLanguages according to the request displayLanguages - A list of objects associating the language codes with display languages

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/droplet/DisplayLanguagesDroplet.java#4 $$Change: 796223 $

Author:

ATG

Nested Class Summary

static class

DisplayLanguagesDroplet.DisplayLanguage Class for display language.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static atg.nucleus.naming.ParameterName	COUNTRY_CODE Country code parameter name.
static java.lang.String	CURRENT_SELECTION Current selection parameter name.
static java.lang.String	DISPLAY_LANGUAGES Display languages parameter name.
static java.lang.String	LANG_SELECTION Locale parameter name.
static atg.nucleus.naming.ParameterName	LANGUAGES Language parameter name.
static java.lang.String	OUTPUT Output parameter name.

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

DisplayLanguagesDroplet()

Method Summary

java.lang.String	createLinkURL(java.util.Locale pLocale, atg.servlet.DynamoHttpServletRequest pRequest) Generate a URL to the current page with the locale parameter set to pLocale.
CatalogNavigationService	getCatalogNavigation()
atg.commerce.endeca.cache.DimensionValueCacheTools	getDimensionValueCacheTools()
com.endeca.infront.navigation.url.UrlNavigationStateBuilder	getNavigationStateBuilder()
atg.servlet.RequestLocale	getRequestLocale()
protected boolean	isIgnoredParameter(java.lang.String pName, javax.servlet.http.HttpServletRequest pRequest) Logic to determine if a parameter should be added to the language switching URL.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Renders "displayLanguages" output parameter which is a list of objects associating the language codes with display languages.
void	setCatalogNavigation(CatalogNavigationService pCatalogNavigationService)
void	setDimensionValueCacheTools(atg.commerce.endeca.cache.DimensionValueCacheTools pDimensionValueCacheTools)
void	setNavigationStateBuilder(com.endeca.infront.navigation.url.UrlNavigationStateBuilder pNavigationStateBuilder)
void	setRequestLocale(atg.servlet.RequestLocale pRequestLocale)

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

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

COUNTRY_CODE

public static final atg.nucleus.naming.ParameterName COUNTRY_CODE

Country code parameter name.

LANGUAGES

public static final atg.nucleus.naming.ParameterName LANGUAGES

Language parameter name.

DISPLAY_LANGUAGES

public static final java.lang.String DISPLAY_LANGUAGES

Display languages parameter name.

See Also:

Constant Field Values

CURRENT_SELECTION

public static final java.lang.String CURRENT_SELECTION

Current selection parameter name.

See Also:

Constant Field Values

LANG_SELECTION

public static final java.lang.String LANG_SELECTION

Locale parameter name.

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

Output parameter name.

See Also:

Constant Field Values

Constructor Detail

DisplayLanguagesDroplet

public DisplayLanguagesDroplet()

Method Detail

setRequestLocale

public void setRequestLocale(atg.servlet.RequestLocale pRequestLocale)

Parameters:

pRequestLocale - - request locale.

getRequestLocale

public atg.servlet.RequestLocale getRequestLocale()

Returns:

the request locale.

setCatalogNavigation

public void setCatalogNavigation(CatalogNavigationService pCatalogNavigationService)

Parameters:

pCatalogNavigationService - - The component used to track users catalog navigation.

getCatalogNavigation

public CatalogNavigationService getCatalogNavigation()

Returns:

the component used to track users catalog navigation.

getNavigationStateBuilder

public com.endeca.infront.navigation.url.UrlNavigationStateBuilder getNavigationStateBuilder()

Returns:

Component responsible for building the NavigationState

setNavigationStateBuilder

public void setNavigationStateBuilder(com.endeca.infront.navigation.url.UrlNavigationStateBuilder pNavigationStateBuilder)

Parameters:

pNavigationStateBuilder - Set a new NavigationStateBuilder component

setDimensionValueCacheTools

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

Parameters:

pDimensionValueCacheTools - - The utility class for access to the ATG<->Endeca catalog cache.

getDimensionValueCacheTools

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

Returns:

the utility class for access to the ATG<->Endeca catalog cache.

service

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

Renders "displayLanguages" output parameter which is a list of objects associating the language codes with display languages.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - DynamoHttpSevletRequest

pResponse - DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

createLinkURL

public java.lang.String createLinkURL(java.util.Locale pLocale,
                                      atg.servlet.DynamoHttpServletRequest pRequest)

Generate a URL to the current page with the locale parameter set to pLocale. On clicking the generated link the page should reload in the language indicated by pLocale.

Parameters:

pLocale - - A locale

pRequest - - HTTP request

Returns:

URL to the current page with the locale parameter set to the locale represented by pLocale.

isIgnoredParameter

protected boolean isIgnoredParameter(java.lang.String pName,
                                     javax.servlet.http.HttpServletRequest pRequest)

Logic to determine if a parameter should be added to the language switching URL.

Parameters:

pName - Parameter name

pRequest - The current HTTPServletRequest

Returns: