org.apache.taglibs.mailer
Class AttachTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.apache.taglibs.mailer.AttachTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public class AttachTag
extends javax.servlet.jsp.tagext.BodyTagSupport

AttachTag - JSP tag Attach is used to set the message in an email. attach org.apache.taglibs.mailer.AttachTag JSP Adds attachments to email.

Version:
1.0
Author:
Rich Catlett Jayson Falkner
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
AttachTag()
           
 
Method Summary
 int doAfterBody()
          implementation of the method from the tag interface that tells the JSP page what to do after the body of this tag
 int doEndTag()
          implementation of method from the Tag interface that tells the JSP what to do upon encountering the end tag for this tag set
 int doStartTag()
          implementation of method from the Tag interface that tells the JSP what to do upon encountering the start tag for this tag set
 void setFile(java.lang.String value)
          set the named file up as an attachment to be added to the list of attachments for this e-mail
protected  void setFileBodyPart(java.lang.String value)
          wrap the file attachment in the approiate datahandler and create a mimebodypart to be added to the list of attachments
 void setType(java.lang.String value)
          set the mime type for this email text or html
 void setUrl(java.lang.String value)
          set the resource named by URL into a mimebodypart so that it can be added to the list of attachments for this e-mail
protected  void setUrlBodyPart(java.lang.String value)
          wrap the url named attachment in the approiate datahandler and create a mimebodypart to be added to the list of attachments
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

AttachTag

public AttachTag()
Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
implementation of method from the Tag interface that tells the JSP what to do upon encountering the start tag for this tag set

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
Returns:
EVAL_BODY_TAG - integer value telling the JSP engine to evaluate the body of this tag
Throws:
javax.servlet.jsp.JspException - thrown when error occurs in processing the body of this method

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException
implementation of the method from the tag interface that tells the JSP page what to do after the body of this tag

Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
Overrides:
doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport
Returns:
SKIP_BODY int telling the tag handler to not evaluate the body of this tag again
Throws:
javax.servlet.jsp.JspException - thrown when an error occurs while processing the body of this method

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
implementation of method from the Tag interface that tells the JSP what to do upon encountering the end tag for this tag set

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
Returns:
- integer value telling the JSP engine whether or not to evaluate the body of this tag
Throws:
javax.servlet.jsp.JspException - thrown when error occurs in processing the body of this method

setType

public void setType(java.lang.String value)
set the mime type for this email text or html

Parameters:
value - string that is the mime type for this email

setUrl

public void setUrl(java.lang.String value)
set the resource named by URL into a mimebodypart so that it can be added to the list of attachments for this e-mail

Parameters:
value - full url including http://, to the resource to be added as an attachment

setFile

public void setFile(java.lang.String value)
set the named file up as an attachment to be added to the list of attachments for this e-mail

Parameters:
value - name of the file to be added as an attachment

setUrlBodyPart

protected void setUrlBodyPart(java.lang.String value)
                       throws javax.servlet.jsp.JspException
wrap the url named attachment in the approiate datahandler and create a mimebodypart to be added to the list of attachments

Parameters:
value - string that represents a URL
Throws:
javax.servlet.jsp.JspException

setFileBodyPart

protected void setFileBodyPart(java.lang.String value)
                        throws javax.servlet.jsp.JspException
wrap the file attachment in the approiate datahandler and create a mimebodypart to be added to the list of attachments

Parameters:
value - string that represents a file path
Throws:
javax.servlet.jsp.JspException


Copyright ? 2000-2004 The Apache Software Foundation. All Rights Reserved.