You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@river.apache.org by si...@apache.org on 2010/12/24 21:33:47 UTC
svn commit: r1052597 [1/2] - in
/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection:
./ class-use/ doc-files/
Author: sijskes
Date: Fri Dec 24 20:33:47 2010
New Revision: 1052597
URL: http://svn.apache.org/viewvc?rev=1052597&view=rev
Log:
doc integration
Added:
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/Connection.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionEndpoint.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionManager.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/InboundRequestHandle.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/OutboundRequestHandle.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ServerConnection.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ServerConnectionManager.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/class-use/
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/doc-files/
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/package-frame.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/package-summary.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/package-tree.html
incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/package-use.html
Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/Connection.html
URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/Connection.html?rev=1052597&view=auto
==============================================================================
--- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/Connection.html (added)
+++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/Connection.html Fri Dec 24 20:33:47 2010
@@ -0,0 +1,476 @@
+<!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.5.0_15) on Mon Mar 08 17:46:19 EST 2010 -->
+<TITLE>
+Connection (Apache River v2.1.2-SNAPSHOT API Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="net.jini.jeri.connection.Connection interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Connection (Apache River v2.1.2-SNAPSHOT API Documentation)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Connection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/Connection.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Connection.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <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.jini.jeri.connection</FONT>
+<BR>
+Interface Connection</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>Connection</B></DL>
+</PRE>
+
+<P>
+Represents an established client-side connection. For example, a
+ TCP-based <code>Connection</code> implementation typically contains
+ a <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/Socket.html" title="class or interface in java.net"><CODE>Socket</CODE></A>.
+
+ <p><code>Connection</code> is implemented by connection-based
+ <A HREF="../../../../net/jini/jeri/Endpoint.html" title="interface in net.jini.jeri"><CODE>Endpoint</CODE></A> implementations that use <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><CODE>ConnectionManager</CODE></A>
+ for managing connections. A <code>Connection</code> is created by
+ the implementation for newly-established connections and is
+ obtained by a <code>ConnectionManager</code> from its <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><CODE>ConnectionEndpoint</CODE></A>'s <code>connect</code> methods.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+<DT><B>Author:</B></DT>
+ <DD>Sun Microsystems, Inc.</DD>
+</DL>
+<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> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#close()">close</A></B>()</CODE>
+
+<BR>
+ Closes this connection.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels">SocketChannel</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#getChannel()">getChannel</A></B>()</CODE>
+
+<BR>
+ Returns a socket channel that performs I/O on this connection,
+ or <code>null</code> if no socket channel is available.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#getInputStream()">getInputStream</A></B>()</CODE>
+
+<BR>
+ Returns an input stream that reads data from this connection.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#getOutputStream()">getOutputStream</A></B>()</CODE>
+
+<BR>
+ Returns an output stream that writes data to this connection.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../net/jini/core/constraint/InvocationConstraints.html" title="class in net.jini.core.constraint">InvocationConstraints</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#getUnfulfilledConstraints(net.jini.jeri.connection.OutboundRequestHandle)">getUnfulfilledConstraints</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle)</CODE>
+
+<BR>
+ Implements <A HREF="../../../../net/jini/jeri/OutboundRequest.html#getUnfulfilledConstraints()"><CODE>OutboundRequest.getUnfulfilledConstraints</CODE></A> for a request with
+ the specified handle.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#populateContext(net.jini.jeri.connection.OutboundRequestHandle, java.util.Collection)">populateContext</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> context)</CODE>
+
+<BR>
+ Populates the supplied collection with context information
+ representing a request with the specified handle.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#readResponseData(net.jini.jeri.connection.OutboundRequestHandle, java.io.InputStream)">readResponseData</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> stream)</CODE>
+
+<BR>
+ Reads from the specified stream any per-response data required
+ by this connection for a request with the specified handle.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/Connection.html#writeRequestData(net.jini.jeri.connection.OutboundRequestHandle, java.io.OutputStream)">writeRequestData</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> stream)</CODE>
+
+<BR>
+ Writes to the specified stream any per-request data required by
+ this connection for a request with the specified handle.</TD>
+</TR>
+</TABLE>
+
+<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="getInputStream()"><!-- --></A><H3>
+getInputStream</H3>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> <B>getInputStream</B>()
+ throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Returns an input stream that reads data from this connection.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an input stream that reads data from this connection
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O exception occurs</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getOutputStream()"><!-- --></A><H3>
+getOutputStream</H3>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> <B>getOutputStream</B>()
+ throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Returns an output stream that writes data to this connection.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an output stream that writes data to this connection
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O exception occurs</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getChannel()"><!-- --></A><H3>
+getChannel</H3>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels">SocketChannel</A> <B>getChannel</B>()</PRE>
+<DL>
+<DD>Returns a socket channel that performs I/O on this connection,
+ or <code>null</code> if no socket channel is available. If a
+ non-<code>null</code> socket channel is returned, it is
+ connected.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a socket channel that performs I/O on this connection,
+ or <code>null</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="populateContext(net.jini.jeri.connection.OutboundRequestHandle, java.util.Collection)"><!-- --></A><H3>
+populateContext</H3>
+<PRE>
+void <B>populateContext</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> context)</PRE>
+<DL>
+<DD>Populates the supplied collection with context information
+ representing a request with the specified handle. This method
+ is used to implement <A HREF="../../../../net/jini/jeri/OutboundRequest.html#populateContext(java.util.Collection)"><CODE>OutboundRequest.populateContext</CODE></A> for such requests; the context
+ may also be populated by the connection manager.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - the handle for the request<DD><CODE>context</CODE> - the context collection to populate
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified handle was
+ not created for use with a connection endpoint equivalent to
+ the one used to create this connection
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>handle</code> or
+ <code>context</code> is <code>null</code>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if <code>context</code>
+ is unmodifiable</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getUnfulfilledConstraints(net.jini.jeri.connection.OutboundRequestHandle)"><!-- --></A><H3>
+getUnfulfilledConstraints</H3>
+<PRE>
+<A HREF="../../../../net/jini/core/constraint/InvocationConstraints.html" title="class in net.jini.core.constraint">InvocationConstraints</A> <B>getUnfulfilledConstraints</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle)</PRE>
+<DL>
+<DD>Implements <A HREF="../../../../net/jini/jeri/OutboundRequest.html#getUnfulfilledConstraints()"><CODE>OutboundRequest.getUnfulfilledConstraints</CODE></A> for a request with
+ the specified handle.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - the handle for the request
+<DT><B>Returns:</B><DD>the constraints for the request that must be partially
+ or fully implemented by higher layers
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified handle was
+ not created for use with a connection endpoint equivalent to
+ the one used to create this connection
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>handle</code> is
+ <code>null</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="writeRequestData(net.jini.jeri.connection.OutboundRequestHandle, java.io.OutputStream)"><!-- --></A><H3>
+writeRequestData</H3>
+<PRE>
+void <B>writeRequestData</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> stream)
+ throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Writes to the specified stream any per-request data required by
+ this connection for a request with the specified handle.
+
+ <p>This method is invoked by <code>ConnectionManager</code>
+ with the request output stream of the <A HREF="../../../../net/jini/jeri/OutboundRequest.html" title="interface in net.jini.jeri"><CODE>OutboundRequest</CODE></A>
+ that it creates for the request. This method can be used, for
+ example, to convey per-request information about delegation,
+ client authentication, or client privileges.
+
+ <p>There may be multiple requests in progress concurrently over
+ this connection, and data written to the specified stream may
+ be buffered and multiplexed with data from other requests
+ before being written to this connection's underlying output
+ stream. Therefore, this method should only write data to the
+ specified stream and must not read any data from this
+ connection's underlying input stream; data can, however, be
+ subsequently read with <A HREF="../../../../net/jini/jeri/connection/Connection.html#readResponseData(net.jini.jeri.connection.OutboundRequestHandle, java.io.InputStream)"><CODE>readResponseData</CODE></A>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - the handle for the request<DD><CODE>stream</CODE> - the request output stream of the request
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/SecurityException.html" title="class or interface in java.lang">SecurityException</A></CODE> - if a security exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified handle was
+ not created for use with a connection endpoint equivalent to
+ the one used to create this connection
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>handle</code> or
+ <code>stream</code> is <code>null</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="readResponseData(net.jini.jeri.connection.OutboundRequestHandle, java.io.InputStream)"><!-- --></A><H3>
+readResponseData</H3>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A> <B>readResponseData</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> stream)
+ throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Reads from the specified stream any per-response data required
+ by this connection for a request with the specified handle.
+
+ <p>This method returns <code>null</code> if the information
+ read (if any) indicates that the constraints are satisfied, and
+ it returns an exception if the constraints could not be
+ satisfied. If an exception is returned rather than thrown, the
+ delivery status of a corresponding <A HREF="../../../../net/jini/jeri/OutboundRequest.html" title="interface in net.jini.jeri"><CODE>OutboundRequest</CODE></A> will
+ be <code>false</code>.
+
+ <p>This method is invoked by <code>ConnectionManager</code>
+ with the response input stream of the
+ <code>OutboundRequest</code> that it creates for the request
+ and the same handle that was passed to <A HREF="../../../../net/jini/jeri/connection/Connection.html#writeRequestData(net.jini.jeri.connection.OutboundRequestHandle, java.io.OutputStream)"><CODE>writeRequestData</CODE></A>. This method can be used to read information
+ produced by <A HREF="../../../../net/jini/jeri/connection/ServerConnection.html#processRequestData(java.io.InputStream, java.io.OutputStream)"><CODE>ServerConnection.processRequestData</CODE></A> in response to the
+ information sent by <code>writeRequestData</code>.
+
+ <p>There may be multiple requests in progress concurrently over
+ this connection, and data read from the specified stream may
+ have been buffered and multiplexed with data from other
+ requests being read from this connection's underlying input
+ stream. Therefore, this method should only read data from the
+ specified stream and must not write any data to this
+ connection's underlying output stream.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - the handle for the request<DD><CODE>stream</CODE> - the response input stream of the request
+<DT><B>Returns:</B><DD><code>null</code> if the constraints are satisfied, or
+ an exception if the constraints could not be satisfied
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/SecurityException.html" title="class or interface in java.lang">SecurityException</A></CODE> - if a security exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified handle was
+ not created for use with a connection endpoint equivalent to
+ the one used to create this connection
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>handle</code> or
+ <code>stream</code> is <code>null</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="close()"><!-- --></A><H3>
+close</H3>
+<PRE>
+void <B>close</B>()
+ throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Closes this connection.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O exception occurs</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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Connection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/Connection.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Connection.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright 2007, multiple authors.<br>Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="child" >Apache License, Version 2.0</a>, see the <a href="../../../../doc-files/NOTICE" target="child" >NOTICE</a> file for attributions.
+</BODY>
+</HTML>
Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionEndpoint.html
URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionEndpoint.html?rev=1052597&view=auto
==============================================================================
--- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionEndpoint.html (added)
+++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionEndpoint.html Fri Dec 24 20:33:47 2010
@@ -0,0 +1,366 @@
+<!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.5.0_15) on Mon Mar 08 17:46:19 EST 2010 -->
+<TITLE>
+ConnectionEndpoint (Apache River v2.1.2-SNAPSHOT API Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="net.jini.jeri.connection.ConnectionEndpoint interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="ConnectionEndpoint (Apache River v2.1.2-SNAPSHOT API Documentation)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ConnectionEndpoint.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/ConnectionEndpoint.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ConnectionEndpoint.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <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.jini.jeri.connection</FONT>
+<BR>
+Interface ConnectionEndpoint</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>ConnectionEndpoint</B></DL>
+</PRE>
+
+<P>
+Represents a remote communication endpoint to establish connections
+ to. For example, a TCP-based <code>ConnectionEndpoint</code>
+ implementation typically contains the remote host address and TCP
+ port to connect to.
+
+ <p><code>ConnectionEndpoint</code> is implemented by
+ connection-based <A HREF="../../../../net/jini/jeri/Endpoint.html" title="interface in net.jini.jeri"><CODE>Endpoint</CODE></A> implementations that use <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><CODE>ConnectionManager</CODE></A> for managing connections. A
+ <code>ConnectionManager</code> is created for a given
+ <code>ConnectionEndpoint</code>, and it uses that
+ <code>ConnectionEndpoint</code> to choose an established connection
+ for a given request or to establish a new connection for a given
+ request.
+
+ <p>An instance of this interface should implement <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals</CODE></A> to obey the guidelines that are
+ specified for <code>equals</code> methods of <A HREF="../../../../net/jini/jeri/Endpoint.html" title="interface in net.jini.jeri"><CODE>Endpoint</CODE></A>
+ instances.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+<DT><B>Author:</B></DT>
+ <DD>Sun Microsystems, Inc.</DD>
+</DL>
+<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> <A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection">Connection</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html#connect(net.jini.jeri.connection.OutboundRequestHandle)">connect</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle)</CODE>
+
+<BR>
+ Returns a new connection that can be used to send a request for
+ the specified handle.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection">Connection</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html#connect(net.jini.jeri.connection.OutboundRequestHandle, java.util.Collection, java.util.Collection)">connect</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> active,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> idle)</CODE>
+
+<BR>
+ Returns an existing or new connection that can be used to send
+ a request for the specified handle, or <code>null</code> if a
+ new connection needs to be created in a way that requires
+ synchronous I/O.</TD>
+</TR>
+</TABLE>
+
+<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="connect(net.jini.jeri.connection.OutboundRequestHandle)"><!-- --></A><H3>
+connect</H3>
+<PRE>
+<A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection">Connection</A> <B>connect</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle)
+ throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Returns a new connection that can be used to send a request for
+ the specified handle.
+
+ <p>The actual network connection might not be completely
+ established when this method returns; connection establishment
+ (including any permission checks required) may proceed
+ asynchronously.
+
+ <p>Either this method or the returned connection must
+ eventually check and throw a <code>SecurityException</code> if
+ the calling thread (at the point of the check) does not have
+ the requisite permissions to send an outbound request for the
+ specified handle. If an exception is thrown, data written to
+ the connection's output stream must not have been transmitted
+ to the server, and the client's identity must not have been
+ revealed to the server.
+
+ <p>Either this method or the returned connection must
+ eventually check and throw an <code>IOException</code> if the
+ client or server does not have the requisite principals and
+ credentials to allow the client to send an outbound request for
+ the specified handle. If an exception is thrown, data written
+ to the connection's output stream must not have been
+ transmitted to the server.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - the handle for the request
+<DT><B>Returns:</B><DD>a new connection that can be used to send a request for
+ the specified handle
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/SecurityException.html" title="class or interface in java.lang">SecurityException</A></CODE> - if a security exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified handle was
+ not created for use with an equivalent connection endpoint
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>handle</code> is
+ <code>null</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="connect(net.jini.jeri.connection.OutboundRequestHandle, java.util.Collection, java.util.Collection)"><!-- --></A><H3>
+connect</H3>
+<PRE>
+<A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection">Connection</A> <B>connect</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> active,
+ <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> idle)</PRE>
+<DL>
+<DD>Returns an existing or new connection that can be used to send
+ a request for the specified handle, or <code>null</code> if a
+ new connection needs to be created in a way that requires
+ synchronous I/O.
+
+ <p>This method is passed any existing connections, both active
+ and idle, that might be suitable for use. The active
+ connections have other requests in progress; the idle
+ connections do not. All other things being equal, an active
+ connection should be chosen over an idle one, and an idle
+ connection should be chosen over creating a new one. An active
+ (or idle) connection, however, might be less suitable than an
+ idle (or new) one for various reasons, such as being too
+ expensive relative to the constraints that need to be
+ satisfied.
+
+ <p>This method is permitted to alter the state of an idle
+ connection (for example, to renegotiate the constraints in
+ force), but any I/O for that purpose must be performed either
+ asynchronously or at subsequent I/O operations on the
+ connection, and it must be completed before any data written to
+ the connection's output stream is actually transmitted. An
+ implementation that performs any such I/O must distinguish it
+ from I/O performed on the connection's streams.
+
+ <p>This method is permitted to return a new connection, but it
+ must not perform any synchronous I/O to establish the
+ connection; such I/O must be performed either asynchronously or
+ at subsequent I/O operations on the connection. If synchronous
+ I/O is required to create a new connection, this method should
+ return <code>null</code>.
+
+ <p>This method should not assume that the collections are
+ modifiable and should not assume that their contents will
+ remain valid after this method returns.
+
+ <p>Either this method or the returned connection must
+ eventually check and throw a <code>SecurityException</code> if
+ the calling thread (at the point of the check) does not have
+ the requisite permissions to send an outbound request for the
+ specified handle. If an exception is thrown, data written to
+ the connection's output stream must not have been transmitted
+ to the server, and the client's identity must not have been
+ revealed to the server.
+
+ <p>The returned connection must eventually check and throw an
+ <code>IOException</code> if the client or server does not have
+ the requisite principals and credentials to allow the client to
+ send an outbound request for the specified handle. If an
+ exception is thrown, data written to the connection's output
+ stream must not have been transmitted to the server.
+
+ <p>If an existing active connection is returned, this method
+ must ensure that the security and credential checks for the
+ current request will not cause the checks for existing active
+ requests to unnecessarily fail or to incorrectly succeed, and
+ vice versa. Therefore, in practice, this method should only
+ return an existing active connection if all of the security and
+ credential checks are made before this method returns.
+
+ <p>Note that a <code>ConnectionManager</code> never makes
+ concurrent invocations of this method; implementations should
+ take that into consideration when deciding if and how long this
+ method should block.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - the handle for the request<DD><CODE>active</CODE> - the connections with requests in progress<DD><CODE>idle</CODE> - the connections with no requests in progress
+<DT><B>Returns:</B><DD>a connection that can be used to send an outbound
+ request for the specified handle, or <code>null</code>
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/SecurityException.html" title="class or interface in java.lang">SecurityException</A></CODE> - if a security exception occurs
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified handle was
+ not created for use with an equivalent connection endpoint, or
+ a connection in either collection was not created by an
+ equivalent connection endpoint
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if any argument is
+ <code>null</code> or any element of either collection is
+ <code>null</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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ConnectionEndpoint.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/ConnectionEndpoint.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ConnectionEndpoint.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright 2007, multiple authors.<br>Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="child" >Apache License, Version 2.0</a>, see the <a href="../../../../doc-files/NOTICE" target="child" >NOTICE</a> file for attributions.
+</BODY>
+</HTML>
Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionManager.html
URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionManager.html?rev=1052597&view=auto
==============================================================================
--- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionManager.html (added)
+++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/ConnectionManager.html Fri Dec 24 20:33:47 2010
@@ -0,0 +1,368 @@
+<!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.5.0_15) on Mon Mar 08 17:46:19 EST 2010 -->
+<TITLE>
+ConnectionManager (Apache River v2.1.2-SNAPSHOT API Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="net.jini.jeri.connection.ConnectionManager class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="ConnectionManager (Apache River v2.1.2-SNAPSHOT API Documentation)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ConnectionManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/InboundRequestHandle.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/ConnectionManager.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ConnectionManager.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.jini.jeri.connection</FONT>
+<BR>
+Class ConnectionManager</H2>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.jini.jeri.connection.ConnectionManager</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public final class <B>ConnectionManager</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
+</PRE>
+
+<P>
+Provides client-side connection management using the <a
+ href="../../../../net/jini/jeri/connection/doc-files/mux.html">Jini
+ extensible remote invocation (Jini ERI) multiplexing protocol</a>
+ to frame and multiplex requests and responses over connections.
+
+ <p>A <code>ConnectionManager</code> is created by a
+ connection-based <A HREF="../../../../net/jini/jeri/Endpoint.html" title="interface in net.jini.jeri"><CODE>Endpoint</CODE></A> implemention to manage
+ connections to a particular <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><CODE>ConnectionEndpoint</CODE></A>. The <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html#newRequest(net.jini.jeri.connection.OutboundRequestHandle)"><CODE>newRequest</CODE></A> method is used to send a request to the
+ connection endpoint.
+
+ <p>Each request attempt is mapped to a new <i>session</i> of the
+ Jini ERI multiplexing protocol on an established connection chosen
+ by the <code>ConnectionEndpoint</code>. Request data is written as
+ the data sent for the session, and response data is read as the
+ data recdeived for the session.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+<DT><B>Author:</B></DT>
+ <DD>Sun Microsystems, Inc.</DD>
+<DT><B>Implementation Specifics:</B></DT>
+ <DD>This implementation uses the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/Logger.html" title="class or interface in java.util.logging"><CODE>Logger</CODE></A> named
+ <code>net.jini.jeri.connection.ConnectionManager</code> to log
+ information at the following levels:
+
+ <p><table summary="Describes what is logged by ConnectionManager to
+ its logger at various logging levels" border=1 cellpadding=5>
+
+ <tr> <th> Level <th> Description
+
+ <tr> <td> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/Level.html#FINEST" title="class or interface in java.util.logging"><CODE>FINEST</CODE></A> <td> connection opened or
+ reused
+
+ </table>
+
+ <p>This implementation uses the <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/Logger.html" title="class or interface in java.util.logging"><CODE>Logger</CODE></A> named
+ <code>net.jini.jeri.connection.mux</code> to log information at the
+ following levels:
+
+ <p><table summary="Describes what is logged by ConnectionManager to
+ the mux logger at various logging levels" border=1 cellpadding=5>
+
+ <tr> <th> Level <th> Description
+
+ <tr> <td> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/Level.html#WARNING" title="class or interface in java.util.logging"><CODE>WARNING</CODE></A> <td> unexpected exception
+ during asynchronous I/O processing, or thread creation failure
+
+ <tr> <td> <A HREF="../../../../com/sun/jini/logging/Levels.html#HANDLED"><CODE>HANDLED</CODE></A> <td> I/O exception during
+ asynchronous I/O processing
+
+ <tr> <td> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/Level.html#FINEST" title="class or interface in java.util.logging"><CODE>FINEST</CODE></A> <td> detailed implementation
+ activity
+
+ </table>
+
+ <p>This implementation recognizes the following system properties:
+
+ <p><ul>
+
+ <li><code>com.sun.jini.jeri.connectionTimeout</code> - Time in
+ milliseconds to leave idle client-side connections around before
+ closing them. The default value is 15000 milliseconds (15 seconds).
+
+ </ul></DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html#ConnectionManager(net.jini.jeri.connection.ConnectionEndpoint)">ConnectionManager</A></B>(<A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection">ConnectionEndpoint</A> ep)</CODE>
+
+<BR>
+ Creates a new <code>ConnectionManager</code> that manages
+ client-side connections to the specified connection endpoint.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== 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> <A HREF="../../../../net/jini/jeri/OutboundRequestIterator.html" title="interface in net.jini.jeri">OutboundRequestIterator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html#newRequest(net.jini.jeri.connection.OutboundRequestHandle)">newRequest</A></B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle)</CODE>
+
+<BR>
+ Returns an <code>OutboundRequestIterator</code> to use to send
+ a new request for the specified handle to this connection
+ manager's <code>ConnectionEndpoint</code>.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://
java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+
+<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="ConnectionManager(net.jini.jeri.connection.ConnectionEndpoint)"><!-- --></A><H3>
+ConnectionManager</H3>
+<PRE>
+public <B>ConnectionManager</B>(<A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection">ConnectionEndpoint</A> ep)</PRE>
+<DL>
+<DD>Creates a new <code>ConnectionManager</code> that manages
+ client-side connections to the specified connection endpoint.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>ep</CODE> - the connection endpoint</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="newRequest(net.jini.jeri.connection.OutboundRequestHandle)"><!-- --></A><H3>
+newRequest</H3>
+<PRE>
+public <A HREF="../../../../net/jini/jeri/OutboundRequestIterator.html" title="interface in net.jini.jeri">OutboundRequestIterator</A> <B>newRequest</B>(<A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection">OutboundRequestHandle</A> handle)</PRE>
+<DL>
+<DD>Returns an <code>OutboundRequestIterator</code> to use to send
+ a new request for the specified handle to this connection
+ manager's <code>ConnectionEndpoint</code>.
+
+ <p>If the <code>hasNext</code> method of the returned iterator
+ returns <code>true</code>, the <code>next</code> method behaves
+ as follows:
+
+ <blockquote>
+
+ The connection endpoint's <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html#connect(net.jini.jeri.connection.OutboundRequestHandle, java.util.Collection, java.util.Collection)"><CODE>connect</CODE></A> method is invoked with any active connections that
+ have not reached their maximum number of in-progress requests,
+ any idle connections, and <code>handle</code>. If that returns
+ <code>null</code>, the endpoint's <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html#connect(net.jini.jeri.connection.OutboundRequestHandle)"><CODE>connect</CODE></A>
+ method is invoked with <code>handle</code>. In either case, if
+ a new connection is returned, the Jini ERI multiplexing
+ protocol is started on the connection (as the client).
+ Finally, the <A HREF="../../../../net/jini/jeri/connection/Connection.html#writeRequestData(net.jini.jeri.connection.OutboundRequestHandle, java.io.OutputStream)"><CODE>writeRequestData</CODE></A> method of the connection is invoked with
+ <code>handle</code> and the request output stream of the <A HREF="../../../../net/jini/jeri/OutboundRequest.html" title="interface in net.jini.jeri"><CODE>OutboundRequest</CODE></A> that is created for the request. If any
+ exception is thrown while obtaining a connection from the
+ endpoint or writing the request data, that exception is thrown
+ to the caller. The <code>OutboundRequest</code> returned by
+ <code>next</code> will invoke the <A HREF="../../../../net/jini/jeri/connection/Connection.html#readResponseData(net.jini.jeri.connection.OutboundRequestHandle, java.io.InputStream)"><CODE>readResponseData</CODE></A> method of the
+ connection with the specified handle and the response input
+ stream before any other data is read from the response input
+ stream. The <A HREF="../../../../net/jini/jeri/OutboundRequest.html#populateContext(java.util.Collection)"><CODE>populateContext</CODE></A> and <A HREF="../../../../net/jini/jeri/OutboundRequest.html#getUnfulfilledConstraints()"><CODE>getUnfulfilledConstraints</CODE></A> methods of the
+ <code>OutboundRequest</code> are implemented by delegating to
+ the corresponding method of the connection passing
+ <code>handle</code> and the other arguments (if any).
+
+ </blockquote>
+
+ <p>The returned iterator might allow continued iteration if the
+ connection used for the most recent request attempt was shut
+ down gracefully by the server.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>handle</CODE> - a handle to identify the request in later
+ invocations on the connection endpoint and its connections
+<DT><B>Returns:</B><DD>an <code>OutboundRequestIterator</code> to use to send
+ a new request for the specified handle to this connection
+ manager's <code>ConnectionEndpoint</code>
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>handle</code> is
+ <code>null</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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ConnectionManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/InboundRequestHandle.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/ConnectionManager.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ConnectionManager.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright 2007, multiple authors.<br>Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="child" >Apache License, Version 2.0</a>, see the <a href="../../../../doc-files/NOTICE" target="child" >NOTICE</a> file for attributions.
+</BODY>
+</HTML>
Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/InboundRequestHandle.html
URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/InboundRequestHandle.html?rev=1052597&view=auto
==============================================================================
--- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/InboundRequestHandle.html (added)
+++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/InboundRequestHandle.html Fri Dec 24 20:33:47 2010
@@ -0,0 +1,183 @@
+<!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.5.0_15) on Mon Mar 08 17:46:19 EST 2010 -->
+<TITLE>
+InboundRequestHandle (Apache River v2.1.2-SNAPSHOT API Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="net.jini.jeri.connection.InboundRequestHandle interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="InboundRequestHandle (Apache River v2.1.2-SNAPSHOT API Documentation)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/InboundRequestHandle.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/InboundRequestHandle.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="InboundRequestHandle.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | METHOD</FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | METHOD</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+net.jini.jeri.connection</FONT>
+<BR>
+Interface InboundRequestHandle</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>InboundRequestHandle</B></DL>
+</PRE>
+
+<P>
+Associates information with a request that is being received on a
+ <A HREF="../../../../net/jini/jeri/connection/ServerConnection.html" title="interface in net.jini.jeri.connection"><CODE>ServerConnection</CODE></A>.
+
+ <p>An <code>InboundRequestHandle</code> is an opaque cookie
+ provided to a <A HREF="../../../../net/jini/jeri/connection/ServerConnectionManager.html" title="class in net.jini.jeri.connection"><CODE>ServerConnectionManager</CODE></A> by a connection-based
+ <A HREF="../../../../net/jini/jeri/ServerEndpoint.html" title="interface in net.jini.jeri"><CODE>ServerEndpoint</CODE></A> implementation, via <A HREF="../../../../net/jini/jeri/connection/ServerConnection.html#processRequestData(java.io.InputStream, java.io.OutputStream)"><CODE>ServerConnection.processRequestData</CODE></A>, in order to identify the
+ request in later invocations of certain <A HREF="../../../../net/jini/jeri/connection/ServerConnection.html" title="interface in net.jini.jeri.connection"><CODE>ServerConnection</CODE></A>
+ methods. The handle encapsulates any request-specific information
+ needed by the transport implementation.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+<DT><B>Author:</B></DT>
+ <DD>Sun Microsystems, Inc.</DD>
+</DL>
+<HR>
+
+<P>
+
+<P>
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/InboundRequestHandle.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/OutboundRequestHandle.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/InboundRequestHandle.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="InboundRequestHandle.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | METHOD</FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | METHOD</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright 2007, multiple authors.<br>Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="child" >Apache License, Version 2.0</a>, see the <a href="../../../../doc-files/NOTICE" target="child" >NOTICE</a> file for attributions.
+</BODY>
+</HTML>
Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/OutboundRequestHandle.html
URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/OutboundRequestHandle.html?rev=1052597&view=auto
==============================================================================
--- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/OutboundRequestHandle.html (added)
+++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/connection/OutboundRequestHandle.html Fri Dec 24 20:33:47 2010
@@ -0,0 +1,187 @@
+<!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.5.0_15) on Mon Mar 08 17:46:19 EST 2010 -->
+<TITLE>
+OutboundRequestHandle (Apache River v2.1.2-SNAPSHOT API Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="net.jini.jeri.connection.OutboundRequestHandle interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="OutboundRequestHandle (Apache River v2.1.2-SNAPSHOT API Documentation)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OutboundRequestHandle.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/InboundRequestHandle.html" title="interface in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/ServerConnection.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/OutboundRequestHandle.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="OutboundRequestHandle.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | METHOD</FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | METHOD</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+net.jini.jeri.connection</FONT>
+<BR>
+Interface OutboundRequestHandle</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>OutboundRequestHandle</B></DL>
+</PRE>
+
+<P>
+Associates information with a request that is being sent to a
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><CODE>ConnectionEndpoint</CODE></A>. The same handle is associated with all
+ <A HREF="../../../../net/jini/jeri/OutboundRequest.html" title="interface in net.jini.jeri"><CODE>OutboundRequest</CODE></A> instances produced by the same <A HREF="../../../../net/jini/jeri/OutboundRequestIterator.html" title="interface in net.jini.jeri"><CODE>OutboundRequestIterator</CODE></A> (that is, all attempts to send the same
+ request).
+
+ <p>An <code>OutboundRequestHandle</code> is an opaque cookie
+ provided to a <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html" title="class in net.jini.jeri.connection"><CODE>ConnectionManager</CODE></A> by a connection-based
+ <A HREF="../../../../net/jini/jeri/Endpoint.html" title="interface in net.jini.jeri"><CODE>Endpoint</CODE></A> implementation (via <A HREF="../../../../net/jini/jeri/connection/ConnectionManager.html#newRequest(net.jini.jeri.connection.OutboundRequestHandle)"><CODE>ConnectionManager.newRequest</CODE></A>) in
+ order to identify the request in later invocations of certain
+ <A HREF="../../../../net/jini/jeri/connection/ConnectionEndpoint.html" title="interface in net.jini.jeri.connection"><CODE>ConnectionEndpoint</CODE></A> and <A HREF="../../../../net/jini/jeri/connection/Connection.html" title="interface in net.jini.jeri.connection"><CODE>Connection</CODE></A> methods. The
+ handle encapsulates information about the constraints for the
+ request and any other request-specific information needed by the
+ transport implementation.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+<DT><B>Author:</B></DT>
+ <DD>Sun Microsystems, Inc.</DD>
+</DL>
+<HR>
+
+<P>
+
+<P>
+<!-- ========= 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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OutboundRequestHandle.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../net/jini/jeri/connection/InboundRequestHandle.html" title="interface in net.jini.jeri.connection"><B>PREV CLASS</B></A>
+ <A HREF="../../../../net/jini/jeri/connection/ServerConnection.html" title="interface in net.jini.jeri.connection"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?net/jini/jeri/connection/OutboundRequestHandle.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="OutboundRequestHandle.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | FIELD | CONSTR | METHOD</FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | METHOD</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright 2007, multiple authors.<br>Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="child" >Apache License, Version 2.0</a>, see the <a href="../../../../doc-files/NOTICE" target="child" >NOTICE</a> file for attributions.
+</BODY>
+</HTML>