de.kl.xsreports
Class MailtoServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          de.kl.xsreports.MailtoServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class MailtoServlet
extends javax.servlet.http.HttpServlet

Diese Klasse wird vom Client aufgerufen, um einen Report zu erzeugen. Es wird wie folgt vorgegangen:

• Fuer jeden Report den eine Applikation erzeugen kann wird in der Datei WEB.XML ein Servlet konfiguriert.
• Diese Klasse implementiert all diese Servlet's und wird demzufolge jeweils als servlet-class angegeben.
• Mit Hilfe der init-param Eintraege des Servelets wird der jeweilige Report konfiguriert.
• Fuer jeden Report werden ein oder mehrere servlet-mapping Eintraege angelegt. Der Client kann den Report dann via "Link" abrufen. Dieses Servlet versendet den Report mit dem "Default" Mail Programm - falls dieses Progamm richtig konfiguriert ist. Mit dem Internet - Explorer wird die Mail sofort versendet, der FireFox oeffnet das Mail-Proogramm (zum Beispiel Outlook) und uebertraegt die Daten in eine neues Mail Formular. Diese Hier die Liste der Parameter dieses Servlet

   generator.class      - Klassenname der Generators. 
                          Beispiel: de.kl.xsreports.TextGenerator
                          Anmerkung: man kann hier zwar jede "Generator"
                          Klasse angeben, aber der "Body" der Mail
                          kann nur Text oder bestenfalls noch HTML
                          enthalten. RTF macht also keinen Sinn.
   
   template.class       - Name der Klasse die das Template laed.
                          Beispiel: de.kl.xsreports.FileHandler
   
   template.name        - Name des Templates. Aus dem Template
                          wird der "Body" Text der Mail gebildet.
                          Das Template kann Symbole wie z.B. ${name}
                          enthalten.
                          Beispiel: mymail.txt
                          Anmerkung: wenn fuer template.class 
                          "de.kl.xsreports.FileHandler" eintraegt, so
                          wird das Template aus dem "templates" Ver-
                          zeichnis unter "WEB-INF/classes" gelesen.
   
   session.dataattribute- Name des Attributes im Session-Objekt des
                          Benutzers das die Daten fuer den Report 
                          enthaelt. Das Objekt muss das Interface
                          Map implementieren.
   
   session.mail.receiver- Name des Attributes im Session-Objekt das
                          die Mail Adresses des Empfaengers enhaelt.
                          Dieser Parameter ist optional.
  
   session.mail.subject - Name des Attributes im Session-Objekt das
                          den Textwert fuer den "Subject" Eintrag der
                          Mail enthaelt.
                          Dieser Parameter ist optional.
  
   session.mail.title   - Name des Attributes im Session-Objekt das den
                          Textwert fuer den Titel der Mail enthaelt.
                          Dieser Wert ist nicht Teil der Mail sondern
                          wird nur auf der Seite angezeigt von der aus
                          die Mail versendet wird.
                          Dieser Parameter ist optional.
   

  Es gibt auch die Moeglichkeit einen Report einfach im Browser zu oeffnen. Hierzu dient das Servelet ReportServlet.

  Version:

  %version%

  Author:

  nikita

  See Also:

  Serialized Form

  Constructor Summary

  MailtoServlet()
  

  Method Summary

  void	destroy() Destroys the servlet.
  protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the HTTP GET method.
  protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the HTTP POST method.
  java.lang.String	getServletInfo() Returns a short description of the servlet.
  void	init(javax.servlet.ServletConfig Config) Initializes the servlet.
  protected void	processRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes requests for both HTTP GET and POST methods.

  Methods inherited from class javax.servlet.http.HttpServlet

  doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

  Methods inherited from class javax.servlet.GenericServlet

  getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Constructor Detail

  MailtoServlet

  public MailtoServlet()

  Method Detail

  init

  public void init(javax.servlet.ServletConfig Config)
            throws javax.servlet.ServletException

  Initializes the servlet.

  Specified by:

  init in interface javax.servlet.Servlet

  Overrides:

  init in class javax.servlet.GenericServlet

  Parameters:

  Config - Objekt mit den Konfigurationsdaten des Servlets.

  Throws:

  javax.servlet.ServletException - Falls bei der Konfiguration des Servelets Daten fehlen wie: generator.class template.class

  destroy

  public void destroy()

  Destroys the servlet.

  Specified by:

  destroy in interface javax.servlet.Servlet

  Overrides:

  destroy in class javax.servlet.GenericServlet

  processRequest

  protected void processRequest(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws javax.servlet.ServletException,
                                java.io.IOException

  Processes requests for both HTTP GET and POST methods.

  Parameters:

  request - servlet request

  response - servlet response

  Throws:

  javax.servlet.ServletException

  java.io.IOException

  doGet

  protected void doGet(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       java.io.IOException

  Handles the HTTP GET method.

  Overrides:

  doGet in class javax.servlet.http.HttpServlet

  Parameters:

  request - servlet request

  response - servlet response

  Throws:

  javax.servlet.ServletException

  java.io.IOException

  doPost

  protected void doPost(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws javax.servlet.ServletException,
                        java.io.IOException

  Handles the HTTP POST method.

  Overrides:

  doPost in class javax.servlet.http.HttpServlet

  Parameters:

  request - servlet request

  response - servlet response

  Throws:

  javax.servlet.ServletException

  java.io.IOException

  getServletInfo

  public java.lang.String getServletInfo()

  Returns a short description of the servlet.

  Specified by:

  getServletInfo in interface javax.servlet.Servlet

  Overrides:

  getServletInfo in class javax.servlet.GenericServlet

  Returns:

  Eine Beschreibung der Servlets.