connection.html

来自「SUN公司官方J2EE中文帮助文档 应该不错 有兴趣的下来看看 html格式的」· HTML 代码 · 共 497 行 · 第 1/2 页

 it to be configured in a client-specific <CODE>ConnectionFactory</CODE>
 object and transparently assigned to the <CODE>Connection</CODE> object
 it creates.
 
 <P>Alternatively, a client can set a connection's client identifier
 using a provider-specific value. The facility to set a connection's
 client identifier explicitly is not a mechanism for overriding the
 identifier that has been administratively configured. It is provided
 for the case where no administratively specified identifier exists.
 If one does exist, an attempt to change it by setting it must throw an
 <CODE>IllegalStateException</CODE>. If a client sets the client identifier
 explicitly, it must do so immediately after it creates the connection 
 and before any other
 action on the connection is taken. After this point, setting the
 client identifier is a programming error that should throw an
 <CODE>IllegalStateException</CODE>.

 <P>The purpose of the client identifier is to associate a connection and
 its objects with a state maintained on behalf of the client by a 
 provider. The only such state identified by the JMS API is that required
 to support durable subscriptions.

 <P>If another connection with the same <code>clientID</code> is already running when
 this method is called, the JMS provider should detect the duplicate ID and throw
 an <CODE>InvalidClientIDException</CODE>.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>clientID</CODE> - the unique client identifier<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to
                         set the client ID for this connection due
                         to some internal error.<DD><CODE><A HREF="../../javax/jms/InvalidClientIDException.html">InvalidClientIDException</A></CODE> - if the JMS client specifies an
                         invalid or duplicate client ID.<DD><CODE><A HREF="../../javax/jms/IllegalStateException.html">IllegalStateException</A></CODE> - if the JMS client attempts to set
       a connection's client ID at the wrong time or
       when it has been administratively configured.</DL>
</DD>
</DL>
<HR>

<A NAME="getMetaData()"><!-- --></A><H3>
getMetaData</H3>
<PRE>
public <A HREF="../../javax/jms/ConnectionMetaData.html">ConnectionMetaData</A> <B>getMetaData</B>()
                               throws <A HREF="../../javax/jms/JMSException.html">JMSException</A></PRE>
<DL>
<DD>Gets the metadata for this connection.<DD><DL>
<DT><B>Returns:</B><DD>the connection metadata<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to
                         get the connection metadata for this connection.<DT><B>See Also: </B><DD><A HREF="../../javax/jms/ConnectionMetaData.html"><CODE>ConnectionMetaData</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getExceptionListener()"><!-- --></A><H3>
getExceptionListener</H3>
<PRE>
public <A HREF="../../javax/jms/ExceptionListener.html">ExceptionListener</A> <B>getExceptionListener</B>()
                                       throws <A HREF="../../javax/jms/JMSException.html">JMSException</A></PRE>
<DL>
<DD>Gets the <CODE>ExceptionListener</CODE> object for this connection.<DD><DL>
<DT><B>Returns:</B><DD>the <CODE>ExceptionListener</CODE> for this connection<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to
                         get the <CODE>ExceptionListener</CODE> for this 
                         connection.</DL>
</DD>
</DL>
<HR>

<A NAME="setExceptionListener(javax.jms.ExceptionListener)"><!-- --></A><H3>
setExceptionListener</H3>
<PRE>
public void <B>setExceptionListener</B>(<A HREF="../../javax/jms/ExceptionListener.html">ExceptionListener</A>&nbsp;listener)
                          throws <A HREF="../../javax/jms/JMSException.html">JMSException</A></PRE>
<DL>
<DD>Sets an exception listener for this connection.

 <P>If a JMS provider detects a serious problem with a connection, it
 informs the connection's <CODE>ExceptionListener</CODE>, if one has been
 registered. It does this by calling the listener's
 <CODE>onException</CODE> method, passing it a <CODE>JMSException</CODE>
 object describing the problem.

 <P>An exception listener allows a client to be notified of a problem
 asynchronously.
 Some connections only consume messages, so they would have no other 
 way to learn their connection has failed.

 <P>A connection serializes execution of its
 <CODE>ExceptionListener</CODE>.

 <P>A JMS provider should attempt to resolve connection problems 
 itself before it notifies the client of them.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the exception listener<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to
                         set the exception listener for this connection.</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()
           throws <A HREF="../../javax/jms/JMSException.html">JMSException</A></PRE>
<DL>
<DD>Starts (or restarts) a connection's delivery of incoming messages.
 A call to <CODE>start</CODE> on a connection that has already been
 started is ignored.<DD><DL>
<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to start
                         message delivery due to some internal error.<DT><B>See Also: </B><DD><A HREF="../../javax/jms/Connection.html#stop()"><CODE>stop()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()
          throws <A HREF="../../javax/jms/JMSException.html">JMSException</A></PRE>
<DL>
<DD>Temporarily stops a connection's delivery of incoming messages.
 Delivery can be restarted using the connection's <CODE>start</CODE>
 method. When the connection is stopped,
 delivery to all the connection's message consumers is inhibited:
 synchronous receives block, and messages are not delivered to message
 listeners.

 <P>This call blocks until receives and/or message listeners in progress
 have completed.

 <P>Stopping a connection has no effect on its ability to send messages.
 A call to <CODE>stop</CODE> on a connection that has already been
 stopped is ignored.

 <P>A call to <CODE>stop</CODE> must not return until delivery of messages
 has paused. This means that a client can rely on the fact that none of 
 its message listeners will be called and that all threads of control 
 waiting for <CODE>receive</CODE> calls to return will not return with a 
 message until the
 connection is restarted. The receive timers for a stopped connection
 continue to advance, so receives may time out while the connection is
 stopped.
 
 <P>If message listeners are running when <CODE>stop</CODE> is invoked, 
 the <CODE>stop</CODE> call must
 wait until all of them have returned before it may return. While these
 message listeners are completing, they must have the full services of the
 connection available to them.<DD><DL>
<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to stop
                         message delivery due to some internal error.<DT><B>See Also: </B><DD><A HREF="../../javax/jms/Connection.html#start()"><CODE>start()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()
           throws <A HREF="../../javax/jms/JMSException.html">JMSException</A></PRE>
<DL>
<DD>Closes the connection.

 <P>Since a provider typically allocates significant resources outside 
 the JVM on behalf of a connection, clients should close these resources
 when they are not needed. Relying on garbage collection to eventually 
 reclaim these resources may not be timely enough.

 <P>There is no need to close the sessions, producers, and consumers
 of a closed connection.

 <P>Closing a connection causes all temporary destinations to be
 deleted.

 <P>When this method is invoked, it should not return until message
 processing has been shut down in an orderly fashion. This means that all
 message 
 listeners that may have been running have returned, and that all pending 
 receives have returned. A close terminates all pending message receives 
 on the connection's sessions' consumers. The receives may return with a 
 message or with null, depending on whether there was a message available 
 at the time of the close. If one or more of the connection's sessions' 
 message listeners is processing a message at the time when connection 
 <CODE>close</CODE> is invoked, all the facilities of the connection and 
 its sessions must remain available to those listeners until they return 
 control to the JMS provider. 

 <P>Closing a connection causes any of its sessions' transactions
 in progress to be rolled back. In the case where a session's
 work is coordinated by an external transaction manager, a session's 
 <CODE>commit</CODE> and <CODE>rollback</CODE> methods are
 not used and the result of a closed session's work is determined
 later by the transaction manager.

 Closing a connection does NOT force an 
 acknowledgment of client-acknowledged sessions. 
 
 <P>Invoking the <CODE>acknowledge</CODE> method of a received message 
 from a closed connection's session must throw an 
 <CODE>IllegalStateException</CODE>.  Closing a closed connection must 
 NOT throw an exception.<DD><DL>
<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/jms/JMSException.html">JMSException</A></CODE> - if the JMS provider fails to close the
                         connection due to some internal error. For 
                         example, a failure to release resources
                         or to close a socket connection can cause
                         this exception to be thrown.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <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="../../javax/jms/BytesMessage.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/jms/ConnectionConsumer.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Connection.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&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>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>