atg.projects.store.droplet
Class CountryRestrictionsDroplet

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.CountryRestrictionsDroplet

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

This droplet is used to obtain a list of permitted countries in various situations. By specifying an optional country code we are able to return the details of that specific country along with an oparam to indicate whether or not it is restricted or permitted. In the event of no country code being specified the droplet simply returns a list of all permitted countries.

The droplet takes the following input parameters:

• countryCode (optional) The code of the country we wish to check in order to gauge whether or not it is restricted or permitted.

The droplet renders the following open parameters:
• true - the specified country code is restricted.
• false - the specified country code is permitted.
• output - a country code has not been specified so a list of all permitted countries has been returned.

The droplet sets the following output parameters:

• countryDetail The details of the country relating to the specified country code. This is returned when a country code is specified.
• countries A list of all permitted country codes. This is returned when no country code is specified.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/droplet/CountryRestrictionsDroplet.java#2 $$Change: 788983 $

Author:

ATG

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COUNTRIES_PARAM Countries parameter name.
static atg.nucleus.naming.ParameterName	COUNTRY_CODE Country code parameter name.
static java.lang.String	COUNTRY_DETAIL_PARAM Country details parameter name.
static java.lang.String	FALSE_OPARAM Oparam: false.
static java.lang.String	OUTPUT_OPARAM Oparam: output.
static java.lang.String	TRUE_OPARAM Oparam: true.

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

CountryRestrictionsDroplet()

Method Summary

atg.core.i18n.CountryList	getCountryList()
CountryRestrictionsService	getCountryRestrictionsService()
java.lang.String	getPermittedCountriesPropertyName()
java.lang.String	getRestrictedCountriesPropertyName()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Service method.
void	setCountryList(atg.core.i18n.CountryList pCountryList)
void	setCountryRestrictionsService(CountryRestrictionsService pCountryRestrictionsService)
void	setPermittedCountriesPropertyName(java.lang.String pPermittedCountriesPropertyName)
void	setRestrictedCountriesPropertyName(java.lang.String pRestrictedCountriesPropertyName)

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.

COUNTRIES_PARAM

public static final java.lang.String COUNTRIES_PARAM

Countries parameter name.

See Also:

Constant Field Values

COUNTRY_DETAIL_PARAM

public static final java.lang.String COUNTRY_DETAIL_PARAM

Country details parameter name.

See Also:

Constant Field Values

OUTPUT_OPARAM

public static final java.lang.String OUTPUT_OPARAM

Oparam: output.

See Also:

Constant Field Values

TRUE_OPARAM

public static final java.lang.String TRUE_OPARAM

Oparam: true.

See Also:

Constant Field Values

FALSE_OPARAM

public static final java.lang.String FALSE_OPARAM

Oparam: false.

See Also:

Constant Field Values

Constructor Detail

CountryRestrictionsDroplet

public CountryRestrictionsDroplet()

Method Detail

getPermittedCountriesPropertyName

public java.lang.String getPermittedCountriesPropertyName()

Returns:

permitted countries property name.

setPermittedCountriesPropertyName

public void setPermittedCountriesPropertyName(java.lang.String pPermittedCountriesPropertyName)

Parameters:

pPermittedCountriesPropertyName - - permitted countries property name.

getRestrictedCountriesPropertyName

public java.lang.String getRestrictedCountriesPropertyName()

Returns:

restricted countries property name.

setRestrictedCountriesPropertyName

public void setRestrictedCountriesPropertyName(java.lang.String pRestrictedCountriesPropertyName)

Parameters:

pRestrictedCountriesPropertyName - - restricted countries property name.

getCountryList

public atg.core.i18n.CountryList getCountryList()

Returns:

country list.

setCountryList

public void setCountryList(atg.core.i18n.CountryList pCountryList)

Parameters:

pCountryList - - master country list.

getCountryRestrictionsService

public CountryRestrictionsService getCountryRestrictionsService()

Returns:

the countryRestrictionsService

setCountryRestrictionsService

public void setCountryRestrictionsService(CountryRestrictionsService pCountryRestrictionsService)

Parameters:

pCountryRestrictionsService - the countryRestrictionsService to set

service

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

Service method.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - - http request

pResponse - - http response

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs