atg.projects.store.droplet

Class IsEmailRecipient

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

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

Given an emailAddress, this droplet will call into StoreProfileTools.retrieveEmailRecipient(). If a valid item is returned, the droplet renders a "true" oparam, otherwise, "false".

This droplet takes the following input parameters:

• email - The email address of the current Profile

This droplet renders the following oparams:

• true - if current Profile has already subscribed to receive emails
• false - if current Profile has not subscribed to receive emails

Example:

 <dsp:droplet bean="/atg/store/droplet/IsEmailRecipient"> <dsp:param
 name="email" bean="RegistrationFormHandler.value.email"> <dsp:oparam name="true">
 * </dsp:oparam>  <dsp:oparam name="false"> </dsp:oparam></dsp:droplet>

 

Version:

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

Author:

ATG

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected atg.userprofiling.ProfileTools	mProfileTools Profile tools.
static atg.nucleus.naming.ParameterName	OPARAM_OUTPUT_FALSE The oparam name rendered once if current Profile has not subscribed to receive emails.
static atg.nucleus.naming.ParameterName	OPARAM_OUTPUT_TRUE The oparam name rendered once if current Profile has already subscribed to receive emails.
static atg.nucleus.naming.ParameterName	PARAM_EMAIL The input parameter name for the email address to check.

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

Method Summary

Modifier and Type	Method and Description
atg.userprofiling.ProfileTools	getProfileTools()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Given an email address, this will call into StoreProfileTools.retrieveEmailRecipient() to determine if the address is already subscribed to receive emails or not.
void	setProfileTools(atg.userprofiling.ProfileTools pProfileTools)

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

Class version string

See Also:

Constant Field Values

PARAM_EMAIL

public static final atg.nucleus.naming.ParameterName PARAM_EMAIL

The input parameter name for the email address to check.

OPARAM_OUTPUT_TRUE

public static final atg.nucleus.naming.ParameterName OPARAM_OUTPUT_TRUE

The oparam name rendered once if current Profile has already subscribed to receive emails.

OPARAM_OUTPUT_FALSE

public static final atg.nucleus.naming.ParameterName OPARAM_OUTPUT_FALSE

The oparam name rendered once if current Profile has not subscribed to receive emails.

mProfileTools

protected atg.userprofiling.ProfileTools mProfileTools

Profile tools.

Constructor Detail

IsEmailRecipient

public IsEmailRecipient()

Method Detail

getProfileTools

public atg.userprofiling.ProfileTools getProfileTools()

Returns:

the profileTools.

setProfileTools

public void setProfileTools(atg.userprofiling.ProfileTools pProfileTools)

Parameters:

pProfileTools - - The profileTools to set.

service

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

Given an email address, this will call into StoreProfileTools.retrieveEmailRecipient() to determine if the address is already subscribed to receive emails or not.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs