smimesignedparser.html

jijo djoijio oijoij poikijoi joijoij

<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="SMIMESignedParser(javax.mail.internet.MimeMultipart)"><!-- --></A><H3>
SMIMESignedParser</H3>
<PRE>
public <B>SMIMESignedParser</B>(javax.mail.internet.MimeMultipart&nbsp;message)
                  throws javax.mail.MessagingException,
                         <A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></PRE>
<DL>
<DD>base constructor using a defaultContentTransferEncoding of 7bit. A temporary backing file
 will be created for the signed data.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - signed message with signature.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - on an error extracting the signature or
 otherwise processing the message.
<DD><CODE><A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></CODE> - if some other problem occurs.</DL>
</DL>
<HR>

<A NAME="SMIMESignedParser(javax.mail.internet.MimeMultipart, java.io.File)"><!-- --></A><H3>
SMIMESignedParser</H3>
<PRE>
public <B>SMIMESignedParser</B>(javax.mail.internet.MimeMultipart&nbsp;message,
                         java.io.File&nbsp;backingFile)
                  throws javax.mail.MessagingException,
                         <A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></PRE>
<DL>
<DD>base constructor using a defaultContentTransferEncoding of 7bit and a specified backing file.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - signed message with signature.<DD><CODE>backingFile</CODE> - the temporary file to use to back the signed data.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - on an error extracting the signature or
 otherwise processing the message.
<DD><CODE><A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></CODE> - if some other problem occurs.</DL>
</DL>
<HR>

<A NAME="SMIMESignedParser(javax.mail.internet.MimeMultipart, java.lang.String)"><!-- --></A><H3>
SMIMESignedParser</H3>
<PRE>
public <B>SMIMESignedParser</B>(javax.mail.internet.MimeMultipart&nbsp;message,
                         java.lang.String&nbsp;defaultContentTransferEncoding)
                  throws javax.mail.MessagingException,
                         <A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></PRE>
<DL>
<DD>base constructor with settable contentTransferEncoding. A temporary backing file will be created
 to contain the signed data.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the signed message with signature.<DD><CODE>defaultContentTransferEncoding</CODE> - new default to use.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - on an error extracting the signature or
 otherwise processing the message.
<DD><CODE><A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></CODE> - if some other problem occurs.</DL>
</DL>
<HR>

<A NAME="SMIMESignedParser(javax.mail.internet.MimeMultipart, java.lang.String, java.io.File)"><!-- --></A><H3>
SMIMESignedParser</H3>
<PRE>
public <B>SMIMESignedParser</B>(javax.mail.internet.MimeMultipart&nbsp;message,
                         java.lang.String&nbsp;defaultContentTransferEncoding,
                         java.io.File&nbsp;backingFile)
                  throws javax.mail.MessagingException,
                         <A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></PRE>
<DL>
<DD>base constructor with settable contentTransferEncoding and a specified backing file.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the signed message with signature.<DD><CODE>defaultContentTransferEncoding</CODE> - new default to use.<DD><CODE>backingFile</CODE> - the temporary file to use to back the signed data.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - on an error extracting the signature or
 otherwise processing the message.
<DD><CODE><A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></CODE> - if some other problem occurs.</DL>
</DL>
<HR>

<A NAME="SMIMESignedParser(javax.mail.Part)"><!-- --></A><H3>
SMIMESignedParser</H3>
<PRE>
public <B>SMIMESignedParser</B>(javax.mail.Part&nbsp;message)
                  throws javax.mail.MessagingException,
                         <A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A>,
                         <A HREF="../../../../org/bouncycastle/mail/smime/SMIMEException.html" title="class in org.bouncycastle.mail.smime">SMIMEException</A></PRE>
<DL>
<DD>base constructor for a signed message with encapsulated content.
 <p>
 Note: in this case the encapsulated MimeBody part will only be suitable for a single
 writeTo - once writeTo has been called the file containing the body part will be deleted. If writeTo is not
 called the file will be left in the temp directory.
 </p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message containing the encapsulated signed data.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - on an error extracting the signature or
 otherwise processing the message.
<DD><CODE><A HREF="../../../../org/bouncycastle/mail/smime/SMIMEException.html" title="class in org.bouncycastle.mail.smime">SMIMEException</A></CODE> - if the body part encapsulated in the message cannot be extracted.
<DD><CODE><A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></CODE> - if some other problem occurs.</DL>
</DL>
<HR>

<A NAME="SMIMESignedParser(javax.mail.Part, java.io.File)"><!-- --></A><H3>
SMIMESignedParser</H3>
<PRE>
public <B>SMIMESignedParser</B>(javax.mail.Part&nbsp;message,
                         java.io.File&nbsp;file)
                  throws javax.mail.MessagingException,
                         <A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A>,
                         <A HREF="../../../../org/bouncycastle/mail/smime/SMIMEException.html" title="class in org.bouncycastle.mail.smime">SMIMEException</A></PRE>
<DL>
<DD>Constructor for a signed message with encapsulated content. The encapsulated
 content, if it exists, is written to the file represented by the File object 
 passed in.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the Part containing the signed content.<DD><CODE>file</CODE> - the file the encapsulated part is to be written to after it has been decoded.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - on an error extracting the signature or
 otherwise processing the message.
<DD><CODE><A HREF="../../../../org/bouncycastle/mail/smime/SMIMEException.html" title="class in org.bouncycastle.mail.smime">SMIMEException</A></CODE> - if the body part encapsulated in the message cannot be extracted.
<DD><CODE><A HREF="../../../../org/bouncycastle/cms/CMSException.html" title="class in org.bouncycastle.cms">CMSException</A></CODE> - if some other problem occurs.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getContent()"><!-- --></A><H3>
getContent</H3>
<PRE>
public javax.mail.internet.MimeBodyPart <B>getContent</B>()</PRE>
<DL>
<DD>return the content that was signed.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the signed body part in this message.</DL>
</DD>
</DL>
<HR>

<A NAME="getContentAsMimeMessage(javax.mail.Session)"><!-- --></A><H3>
getContentAsMimeMessage</H3>
<PRE>
public javax.mail.internet.MimeMessage <B>getContentAsMimeMessage</B>(javax.mail.Session&nbsp;session)
                                                        throws javax.mail.MessagingException,
                                                               java.io.IOException</PRE>
<DL>
<DD>Return the content that was signed as a mime message.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the session to base the MimeMessage around.
<DT><B>Returns:</B><DD>a MimeMessage holding the content.
<DT><B>Throws:</B>
<DD><CODE>javax.mail.MessagingException</CODE> - if there is an issue creating the MimeMessage.
<DD><CODE>java.io.IOException</CODE> - if there is an issue reading the content.</DL>
</DD>
</DL>
<HR>

<A NAME="getContentWithSignature()"><!-- --></A><H3>
getContentWithSignature</H3>
<PRE>
public java.lang.Object <B>getContentWithSignature</B>()</PRE>
<DL>
<DD>return the content that was signed with its signature attached.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>depending on whether this was unencapsulated or not it will return a MimeMultipart
 or a MimeBodyPart</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Bouncy Castle Cryptography Library 1.42</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/bouncycastle/mail/smime/SMIMESignedGenerator.html" title="class in org.bouncycastle.mail.smime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/bouncycastle/mail/smime/SMIMEStreamingProcessor.html" title="interface in org.bouncycastle.mail.smime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/bouncycastle/mail/smime/SMIMESignedParser.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SMIMESignedParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.bouncycastle.cms.CMSContentInfoParser">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>