atg.userprofiling.email

Class TemplateEmailSender

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.userprofiling.email.TemplateEmailSender

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, atg.servlet.TemplateEmailConstants, java.util.EventListener

public class TemplateEmailSender
extends GenericService
implements atg.servlet.TemplateEmailConstants

The TemplateEmailSender service is responsible for sending template-based email. Given a TemplateEmailInfo and a list of recipient profiles, it renders the jhtml page specified via the TemplateEmailInfo's templateURL property for each of the profiles, uses that to create a Message, and sends each message to the corresponding user.

The template rendering functionality in TemplateEmailSender is implemented with the help of its templateRendererServlet. In the service's standard configuration, this property points to the head of Dynamo's servlet pipeline. Thus, the template page is rendered simply as if it were a jhtml page requested through a browser. However, one can configure the templateRendererServlet property to point to any custom Servlet, which might implement a different scheme for rendering the page.

It's also possible to change the rendering behavior more dramatically by subclassing this service and overriding some of its methods. Here is a detailed description of the rendering process corresponding to a single call to TemplateEmailSender's sendEmailMessage, together with pointers for how the default behavior might be overriden:

1. Given a TemplateEmailInfo which points to a particular templateURL, we create a request/response pair (specifically, instances of DynamoHttpServletRequest and DynamoHttpServletResponse) which will be reused to render the template for each of the recipient profiles. The path info in the request is set to point to the templateURL. In addition, the request is serviced once using the requestSetupServlet (which, in the standard configuration, again points to the head of the servlet pipeline) - this associates the request with a session, sets it up for name resolution, and so on.
2. For each recipient profile, we call the methods initializeRequest and initializeResponse to initialize request/response with any recipient-specific information. The default implementation associates the session-scoped Profile object in the request with the given profile object; this allows us to resolve any references to the profile attributes in the template page when the template is being rendered. Subclasses may override these methods to implement other schemes for associating the recipient's profile with the request, etc.
3. For each recipient profile, we call the method renderTemplate, which takes the already initialized request/response pair and actually performs the rendering. The default implementation simply calls the templateRendererServlet's service method, and captures and returns the output in the response. If you are implementing your own Servlet to do the rendering, note that your servlet can access the template URL by calling getPathInfo on the request. Again, you can also override this method and implement a different scheme for rendering the template.

The actual sending of the email is performed by an EmailMessageSender, pointed at by the service's emailMessageSender property.

See Also:

TemplateEmailInfo, EmailMessageSender