Files
briar/javadoc/net/sf/briar/api/protocol/MessageEncoder.html
akwizgran 928ae6288f Javadocs.
2011-08-31 17:44:42 +01:00

318 lines
16 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Wed Aug 31 17:44:32 BST 2011 -->
<TITLE>
MessageEncoder (Briar)
</TITLE>
<META NAME="date" CONTENT="2011-08-31">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MessageEncoder (Briar)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" 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_top_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>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/briar/api/protocol/MessageEncoder.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MessageEncoder.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.briar.api.protocol</FONT>
<BR>
Interface MessageEncoder</H2>
<HR>
<DL>
<DT><PRE>public interface <B>MessageEncoder</B></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/briar/api/protocol/MessageEncoder.html#encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, net.sf.briar.api.protocol.Author, java.security.PrivateKey, byte[])">encodeMessage</A></B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
<A HREF="../../../../../net/sf/briar/api/protocol/Author.html" title="interface in net.sf.briar.api.protocol">Author</A>&nbsp;author,
java.security.PrivateKey&nbsp;authorKey,
byte[]&nbsp;body)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encodes a pseudonymous message to an unrestricted group.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/briar/api/protocol/MessageEncoder.html#encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, byte[])">encodeMessage</A></B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
byte[]&nbsp;body)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encodes an anonymous to an unrestricted group.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/briar/api/protocol/MessageEncoder.html#encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, java.security.PrivateKey, net.sf.briar.api.protocol.Author, java.security.PrivateKey, byte[])">encodeMessage</A></B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
java.security.PrivateKey&nbsp;groupKey,
<A HREF="../../../../../net/sf/briar/api/protocol/Author.html" title="interface in net.sf.briar.api.protocol">Author</A>&nbsp;author,
java.security.PrivateKey&nbsp;authorKey,
byte[]&nbsp;body)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encode a pseudonymous message to a restricted group.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/briar/api/protocol/MessageEncoder.html#encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, java.security.PrivateKey, byte[])">encodeMessage</A></B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
java.security.PrivateKey&nbsp;groupKey,
byte[]&nbsp;body)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encodes an anonymous message to a restricted group.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ 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="encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, byte[])"><!-- --></A><H3>
encodeMessage</H3>
<PRE>
<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A> <B>encodeMessage</B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
byte[]&nbsp;body)
throws java.io.IOException,
java.security.GeneralSecurityException</PRE>
<DL>
<DD>Encodes an anonymous to an unrestricted group.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>java.security.GeneralSecurityException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, java.security.PrivateKey, byte[])"><!-- --></A><H3>
encodeMessage</H3>
<PRE>
<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A> <B>encodeMessage</B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
java.security.PrivateKey&nbsp;groupKey,
byte[]&nbsp;body)
throws java.io.IOException,
java.security.GeneralSecurityException</PRE>
<DL>
<DD>Encodes an anonymous message to a restricted group.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>java.security.GeneralSecurityException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, net.sf.briar.api.protocol.Author, java.security.PrivateKey, byte[])"><!-- --></A><H3>
encodeMessage</H3>
<PRE>
<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A> <B>encodeMessage</B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
<A HREF="../../../../../net/sf/briar/api/protocol/Author.html" title="interface in net.sf.briar.api.protocol">Author</A>&nbsp;author,
java.security.PrivateKey&nbsp;authorKey,
byte[]&nbsp;body)
throws java.io.IOException,
java.security.GeneralSecurityException</PRE>
<DL>
<DD>Encodes a pseudonymous message to an unrestricted group.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>java.security.GeneralSecurityException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="encodeMessage(net.sf.briar.api.protocol.MessageId, net.sf.briar.api.protocol.Group, java.security.PrivateKey, net.sf.briar.api.protocol.Author, java.security.PrivateKey, byte[])"><!-- --></A><H3>
encodeMessage</H3>
<PRE>
<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol">Message</A> <B>encodeMessage</B>(<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol">MessageId</A>&nbsp;parent,
<A HREF="../../../../../net/sf/briar/api/protocol/Group.html" title="interface in net.sf.briar.api.protocol">Group</A>&nbsp;group,
java.security.PrivateKey&nbsp;groupKey,
<A HREF="../../../../../net/sf/briar/api/protocol/Author.html" title="interface in net.sf.briar.api.protocol">Author</A>&nbsp;author,
java.security.PrivateKey&nbsp;authorKey,
byte[]&nbsp;body)
throws java.io.IOException,
java.security.GeneralSecurityException</PRE>
<DL>
<DD>Encode a pseudonymous message to a restricted group.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>java.security.GeneralSecurityException</CODE></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>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/Message.html" title="interface in net.sf.briar.api.protocol"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../net/sf/briar/api/protocol/MessageId.html" title="class in net.sf.briar.api.protocol"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/briar/api/protocol/MessageEncoder.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MessageEncoder.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>