Add live TLS certificate probing and improve restart error handling.
Configure CertificateCheckUrl per container for curl-like TLS checks, classify Sonic permission errors, and extend setup wizard for container management. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Cursor
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,703 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
Connection (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.Connection interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="Connection (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="Connection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="BytesMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnection.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="Connection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="Connection.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface Connection</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A>, <A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A>, <A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A>, <A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A>, <A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>Connection</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>Connection</CODE> object is a client's active connection to its JMS
|
||||
provider. It typically allocates provider resources outside the Java virtual
|
||||
machine (JVM).
|
||||
|
||||
<P>Connections support concurrent use.
|
||||
|
||||
<P>A connection serves several purposes:
|
||||
|
||||
<UL>
|
||||
<LI>It encapsulates an open connection with a JMS provider. It
|
||||
typically represents an open TCP/IP socket between a client and
|
||||
the service provider software.
|
||||
<LI>Its creation is where client authentication takes place.
|
||||
<LI>It can specify a unique client identifier.
|
||||
<LI>It provides a <CODE>ConnectionMetaData</CODE> object.
|
||||
<LI>It supports an optional <CODE>ExceptionListener</CODE> object.
|
||||
</UL>
|
||||
|
||||
<P>Because the creation of a connection involves setting up authentication
|
||||
and communication, a connection is a relatively heavyweight
|
||||
object. Most clients will do all their messaging with a single connection.
|
||||
Other more advanced applications may use several connections. The JMS API
|
||||
does
|
||||
not architect a reason for using multiple connections; however, there may
|
||||
be operational reasons for doing so.
|
||||
|
||||
<P>A JMS client typically creates a connection, one or more sessions,
|
||||
and a number of message producers and consumers. When a connection is
|
||||
created, it is in stopped mode. That means that no messages are being
|
||||
delivered.
|
||||
|
||||
<P>It is typical to leave the connection in stopped mode until setup
|
||||
is complete (that is, until all message consumers have been
|
||||
created). At that point, the client calls
|
||||
the connection's <CODE>start</CODE> method, and messages begin arriving at
|
||||
the connection's consumers. This setup
|
||||
convention minimizes any client confusion that may result from
|
||||
asynchronous message delivery while the client is still in the process
|
||||
of setting itself up.
|
||||
|
||||
<P>A connection can be started immediately, and the setup can be done
|
||||
afterwards. Clients that do this must be prepared to handle asynchronous
|
||||
message delivery while they are still in the process of setting up.
|
||||
|
||||
<P>A message producer can send messages while a connection is stopped.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="ConnectionFactory.html" title="interface in javax.jms"><CODE>ConnectionFactory</CODE></A>,
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms"><CODE>QueueConnection</CODE></A>,
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms"><CODE>TopicConnection</CODE></A></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="Connection.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the connection.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A></B>(<A HREF="Destination.html" title="interface in javax.jms">Destination</A> destination,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a connection consumer for this connection (optional operation).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String subscriptionName,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)</CODE>
|
||||
|
||||
<BR>
|
||||
Create a durable connection consumer for this connection (optional operation).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Connection.html#createSession(boolean, int)">createSession</A></B>(boolean transacted,
|
||||
int acknowledgeMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>Session</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Connection.html#getClientID()">getClientID</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the client identifier for this connection.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="ExceptionListener.html" title="interface in javax.jms">ExceptionListener</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Connection.html#getExceptionListener()">getExceptionListener</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the <CODE>ExceptionListener</CODE> object for this connection.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="ConnectionMetaData.html" title="interface in javax.jms">ConnectionMetaData</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Connection.html#getMetaData()">getMetaData</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the metadata for this connection.</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="Connection.html#setClientID(java.lang.String)">setClientID</A></B>(java.lang.String clientID)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the client identifier for this connection.</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="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A></B>(<A HREF="ExceptionListener.html" title="interface in javax.jms">ExceptionListener</A> listener)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets an exception listener for this connection.</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="Connection.html#start()">start</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Starts (or restarts) a connection's delivery of incoming messages.</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="Connection.html#stop()">stop</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Temporarily stops a connection's delivery of incoming messages.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">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.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">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>
|
||||
<HR>
|
||||
|
||||
<A NAME="createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)"><!-- --></A><H3>
|
||||
createConnectionConsumer</H3>
|
||||
<PRE>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A> <B>createConnectionConsumer</B>(<A HREF="Destination.html" title="interface in javax.jms">Destination</A> destination,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a connection consumer for this connection (optional operation).
|
||||
This is an expert facility not used by regular JMS clients.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>destination</CODE> - the destination to access<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>sessionPool</CODE> - the server session pool to associate with this
|
||||
connection consumer<DD><CODE>maxMessages</CODE> - the maximum number of messages that can be
|
||||
assigned to a server session at one time
|
||||
<DT><B>Returns:</B><DD>the connection consumer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>Connection</CODE> object fails
|
||||
to create a connection consumer due to some
|
||||
internal error or invalid arguments for
|
||||
<CODE>sessionPool</CODE> and
|
||||
<CODE>messageSelector</CODE>.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid destination is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="ConnectionConsumer.html" title="interface in javax.jms"><CODE>ConnectionConsumer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)"><!-- --></A><H3>
|
||||
createDurableConnectionConsumer</H3>
|
||||
<PRE>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A> <B>createDurableConnectionConsumer</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String subscriptionName,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Create a durable connection consumer for this connection (optional operation).
|
||||
This is an expert facility not used by regular JMS clients.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - topic to access<DD><CODE>subscriptionName</CODE> - durable subscription name<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>sessionPool</CODE> - the server session pool to associate with this
|
||||
durable connection consumer<DD><CODE>maxMessages</CODE> - the maximum number of messages that can be
|
||||
assigned to a server session at one time
|
||||
<DT><B>Returns:</B><DD>the durable connection consumer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>Connection</CODE> object fails
|
||||
to create a connection consumer due to some
|
||||
internal error or invalid arguments for
|
||||
<CODE>sessionPool</CODE> and
|
||||
<CODE>messageSelector</CODE>.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid destination
|
||||
is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="ConnectionConsumer.html" title="interface in javax.jms"><CODE>ConnectionConsumer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createSession(boolean, int)"><!-- --></A><H3>
|
||||
createSession</H3>
|
||||
<PRE>
|
||||
<A HREF="Session.html" title="interface in javax.jms">Session</A> <B>createSession</B>(boolean transacted,
|
||||
int acknowledgeMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>Session</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>transacted</CODE> - indicates whether the session is transacted<DD><CODE>acknowledgeMode</CODE> - indicates whether the consumer or the
|
||||
client will acknowledge any messages it receives; ignored if the session
|
||||
is transacted. Legal values are <code>Session.AUTO_ACKNOWLEDGE</code>,
|
||||
<code>Session.CLIENT_ACKNOWLEDGE</code>, and
|
||||
<code>Session.DUPS_OK_ACKNOWLEDGE</code>.
|
||||
<DT><B>Returns:</B><DD>a newly created session
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>Connection</CODE> object fails
|
||||
to create a session due to some internal error or
|
||||
lack of support for the specific transaction
|
||||
and acknowledgement mode.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#AUTO_ACKNOWLEDGE"><CODE>Session.AUTO_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#CLIENT_ACKNOWLEDGE"><CODE>Session.CLIENT_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#DUPS_OK_ACKNOWLEDGE"><CODE>Session.DUPS_OK_ACKNOWLEDGE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getClientID()"><!-- --></A><H3>
|
||||
getClientID</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getClientID</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the client identifier for this connection.
|
||||
|
||||
<P>This value is specific to the JMS provider. It is either preconfigured
|
||||
by an administrator in a <CODE>ConnectionFactory</CODE> object
|
||||
or assigned dynamically by the application by calling the
|
||||
<code>setClientID</code> method.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the unique client identifier
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to return
|
||||
the client ID for this connection due
|
||||
to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getExceptionListener()"><!-- --></A><H3>
|
||||
getExceptionListener</H3>
|
||||
<PRE>
|
||||
<A HREF="ExceptionListener.html" title="interface in javax.jms">ExceptionListener</A> <B>getExceptionListener</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the <CODE>ExceptionListener</CODE> object for this connection.
|
||||
Not every <CODE>Connection</CODE> has an <CODE>ExceptionListener</CODE>
|
||||
associated with it.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the <CODE>ExceptionListener</CODE> for this connection, or null.
|
||||
if no <CODE>ExceptionListener</CODE> is associated
|
||||
with this connection.
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to
|
||||
get the <CODE>ExceptionListener</CODE> for this
|
||||
connection.<DT><B>See Also:</B><DD><A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)"><CODE>setExceptionListener(javax.jms.ExceptionListener)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getMetaData()"><!-- --></A><H3>
|
||||
getMetaData</H3>
|
||||
<PRE>
|
||||
<A HREF="ConnectionMetaData.html" title="interface in javax.jms">ConnectionMetaData</A> <B>getMetaData</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the metadata for this connection.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the connection metadata
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to
|
||||
get the connection metadata for this connection.<DT><B>See Also:</B><DD><A HREF="ConnectionMetaData.html" title="interface in javax.jms"><CODE>ConnectionMetaData</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setClientID(java.lang.String)"><!-- --></A><H3>
|
||||
setClientID</H3>
|
||||
<PRE>
|
||||
void <B>setClientID</B>(java.lang.String clientID)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the client identifier for this connection.
|
||||
|
||||
<P>The preferred way to assign a JMS client's client identifier is for
|
||||
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>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>clientID</CODE> - the unique client identifier
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">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="InvalidClientIDException.html" title="class in javax.jms">InvalidClientIDException</A></CODE> - if the JMS client specifies an
|
||||
invalid or duplicate client ID.
|
||||
<DD><CODE><A HREF="IllegalStateException.html" title="class in javax.jms">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="setExceptionListener(javax.jms.ExceptionListener)"><!-- --></A><H3>
|
||||
setExceptionListener</H3>
|
||||
<PRE>
|
||||
void <B>setExceptionListener</B>(<A HREF="ExceptionListener.html" title="interface in javax.jms">ExceptionListener</A> listener)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">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.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the exception listener
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">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>
|
||||
void <B>start</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">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.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">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="Connection.html#stop()"><CODE>stop()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="stop()"><!-- --></A><H3>
|
||||
stop</H3>
|
||||
<PRE>
|
||||
void <B>stop</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">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.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">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="Connection.html#start()"><CODE>start()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="Connection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="BytesMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnection.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="Connection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="Connection.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,266 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
ConnectionConsumer (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ConnectionConsumer interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ConnectionConsumer (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ConnectionConsumer.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Connection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnectionConsumer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionConsumer.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="ConnectionConsumer.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ConnectionConsumer.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ConnectionConsumer</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ConnectionConsumer</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
For application servers, <CODE>Connection</CODE> objects provide a special
|
||||
facility
|
||||
for creating a <CODE>ConnectionConsumer</CODE> (optional). The messages it
|
||||
is to consume are
|
||||
specified by a <CODE>Destination</CODE> and a message selector. In addition,
|
||||
a <CODE>ConnectionConsumer</CODE> must be given a
|
||||
<CODE>ServerSessionPool</CODE> to use for
|
||||
processing its messages.
|
||||
|
||||
<P>Normally, when traffic is light, a <CODE>ConnectionConsumer</CODE> gets a
|
||||
<CODE>ServerSession</CODE> from its pool, loads it with a single message, and
|
||||
starts it. As traffic picks up, messages can back up. If this happens,
|
||||
a <CODE>ConnectionConsumer</CODE> can load each <CODE>ServerSession</CODE>
|
||||
with more than one
|
||||
message. This reduces the thread context switches and minimizes resource
|
||||
use at the expense of some serialization of message processing.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)"><CODE>Connection.createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)</CODE></A>,
|
||||
<A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)"><CODE>Connection.createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)</CODE></A>,
|
||||
<A HREF="QueueConnection.html#createConnectionConsumer(javax.jms.Queue, java.lang.String, javax.jms.ServerSessionPool, int)"><CODE>QueueConnection.createConnectionConsumer(javax.jms.Queue, java.lang.String, javax.jms.ServerSessionPool, int)</CODE></A>,
|
||||
<A HREF="TopicConnection.html#createConnectionConsumer(javax.jms.Topic, java.lang.String, javax.jms.ServerSessionPool, int)"><CODE>TopicConnection.createConnectionConsumer(javax.jms.Topic, java.lang.String, javax.jms.ServerSessionPool, int)</CODE></A>,
|
||||
<A HREF="TopicConnection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)"><CODE>TopicConnection.createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)</CODE></A></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="ConnectionConsumer.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the connection consumer.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionConsumer.html#getServerSessionPool()">getServerSessionPool</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the server session pool associated with this connection consumer.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Closes the connection consumer.
|
||||
|
||||
<P>Since a provider may allocate some resources on behalf of a
|
||||
connection consumer outside the Java virtual machine, 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>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to release resources
|
||||
on behalf of the connection consumer or fails
|
||||
to close the connection consumer.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getServerSessionPool()"><!-- --></A><H3>
|
||||
getServerSessionPool</H3>
|
||||
<PRE>
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> <B>getServerSessionPool</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the server session pool associated with this connection consumer.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the server session pool used by this connection consumer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the server
|
||||
session pool associated with this consumer due
|
||||
to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ConnectionConsumer.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Connection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnectionConsumer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionConsumer.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="ConnectionConsumer.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ConnectionConsumer.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,310 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
ConnectionFactory (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ConnectionFactory interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ConnectionFactory (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ConnectionMetaData.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionFactory.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="ConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ConnectionFactory.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ConnectionFactory</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="QueueConnectionFactory.html" title="interface in javax.jms">QueueConnectionFactory</A>, <A HREF="TopicConnectionFactory.html" title="interface in javax.jms">TopicConnectionFactory</A>, <A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms">XAQueueConnectionFactory</A>, <A HREF="XATopicConnectionFactory.html" title="interface in javax.jms">XATopicConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ConnectionFactory</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>ConnectionFactory</CODE> object encapsulates a set of connection
|
||||
configuration
|
||||
parameters that has been defined by an administrator. A client uses
|
||||
it to create a connection with a JMS provider.
|
||||
|
||||
<P>A <CODE>ConnectionFactory</CODE> object is a JMS administered object and
|
||||
supports concurrent use.
|
||||
|
||||
<P>JMS administered objects are objects containing configuration
|
||||
information that are created by an administrator and later used by
|
||||
JMS clients. They make it practical to administer the JMS API in the
|
||||
enterprise.
|
||||
|
||||
<P>Although the interfaces for administered objects do not explicitly
|
||||
depend on the Java Naming and Directory Interface (JNDI) API, the JMS API
|
||||
establishes the convention that JMS clients find administered objects by
|
||||
looking them up in a JNDI namespace.
|
||||
|
||||
<P>An administrator can place an administered object anywhere in a
|
||||
namespace. The JMS API does not define a naming policy.
|
||||
|
||||
<P>It is expected that JMS providers will provide the tools an
|
||||
administrator needs to create and configure administered objects in a
|
||||
JNDI namespace. JMS provider implementations of administered objects
|
||||
should be both <CODE>javax.jndi.Referenceable</CODE> and
|
||||
<CODE>java.io.Serializable</CODE> so that they can be stored in all
|
||||
JNDI naming contexts. In addition, it is recommended that these
|
||||
implementations follow the JavaBeans<SUP><FONT SIZE="-2">TM</FONT></SUP>
|
||||
design patterns.
|
||||
|
||||
<P>This strategy provides several benefits:
|
||||
|
||||
<UL>
|
||||
<LI>It hides provider-specific details from JMS clients.
|
||||
<LI>It abstracts administrative information into objects in the Java
|
||||
programming language ("Java objects")
|
||||
that are easily organized and administered from a common
|
||||
management console.
|
||||
<LI>Since there will be JNDI providers for all popular naming
|
||||
services, this means that JMS providers can deliver one implementation
|
||||
of administered objects that will run everywhere.
|
||||
</UL>
|
||||
|
||||
<P>An administered object should not hold on to any remote resources.
|
||||
Its lookup should not use remote resources other than those used by the
|
||||
JNDI API itself.
|
||||
|
||||
<P>Clients should think of administered objects as local Java objects.
|
||||
Looking them up should not have any hidden side effects or use surprising
|
||||
amounts of local resources.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Connection.html" title="interface in javax.jms"><CODE>Connection</CODE></A>,
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><CODE>QueueConnectionFactory</CODE></A>,
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><CODE>TopicConnectionFactory</CODE></A></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="Connection.html" title="interface in javax.jms">Connection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionFactory.html#createConnection()">createConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a connection with the default user identity.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Connection.html" title="interface in javax.jms">Connection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionFactory.html#createConnection(java.lang.String, java.lang.String)">createConnection</A></B>(java.lang.String userName,
|
||||
java.lang.String password)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a connection with the specified user identity.</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="createConnection()"><!-- --></A><H3>
|
||||
createConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="Connection.html" title="interface in javax.jms">Connection</A> <B>createConnection</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a connection with the default user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create the
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
createConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="Connection.html" title="interface in javax.jms">Connection</A> <B>createConnection</B>(java.lang.String userName,
|
||||
java.lang.String password)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a connection with the specified user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - the caller's user name<DD><CODE>password</CODE> - the caller's password
|
||||
<DT><B>Returns:</B><DD>a newly created connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create the
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ConnectionMetaData.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionFactory.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="ConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ConnectionFactory.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,395 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
ConnectionMetaData (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ConnectionMetaData interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ConnectionMetaData (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ConnectionMetaData.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="DeliveryMode.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnectionMetaData.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionMetaData.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="ConnectionMetaData.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ConnectionMetaData.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ConnectionMetaData</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ConnectionMetaData</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>ConnectionMetaData</CODE> object provides information describing the
|
||||
<CODE>Connection</CODE> object.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getJMSMajorVersion()">getJMSMajorVersion</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS major version number.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getJMSMinorVersion()">getJMSMinorVersion</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS minor version number.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getJMSProviderName()">getJMSProviderName</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS provider name.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getJMSVersion()">getJMSVersion</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS API version.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.util.Enumeration</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getJMSXPropertyNames()">getJMSXPropertyNames</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets an enumeration of the JMSX property names.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getProviderMajorVersion()">getProviderMajorVersion</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS provider major version number.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getProviderMinorVersion()">getProviderMinorVersion</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS provider minor version number.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ConnectionMetaData.html#getProviderVersion()">getProviderVersion</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the JMS provider version.</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="getJMSMajorVersion()"><!-- --></A><H3>
|
||||
getJMSMajorVersion</H3>
|
||||
<PRE>
|
||||
int <B>getJMSMajorVersion</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS major version number.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS API major version number
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJMSMinorVersion()"><!-- --></A><H3>
|
||||
getJMSMinorVersion</H3>
|
||||
<PRE>
|
||||
int <B>getJMSMinorVersion</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS minor version number.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS API minor version number
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJMSProviderName()"><!-- --></A><H3>
|
||||
getJMSProviderName</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getJMSProviderName</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS provider name.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS provider name
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJMSVersion()"><!-- --></A><H3>
|
||||
getJMSVersion</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getJMSVersion</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS API version.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS API version
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJMSXPropertyNames()"><!-- --></A><H3>
|
||||
getJMSXPropertyNames</H3>
|
||||
<PRE>
|
||||
java.util.Enumeration <B>getJMSXPropertyNames</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets an enumeration of the JMSX property names.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an Enumeration of JMSX property names
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getProviderMajorVersion()"><!-- --></A><H3>
|
||||
getProviderMajorVersion</H3>
|
||||
<PRE>
|
||||
int <B>getProviderMajorVersion</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS provider major version number.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS provider major version number
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getProviderMinorVersion()"><!-- --></A><H3>
|
||||
getProviderMinorVersion</H3>
|
||||
<PRE>
|
||||
int <B>getProviderMinorVersion</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS provider minor version number.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS provider minor version number
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getProviderVersion()"><!-- --></A><H3>
|
||||
getProviderVersion</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getProviderVersion</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the JMS provider version.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the JMS provider version
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to retrieve the
|
||||
metadata due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ConnectionMetaData.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="DeliveryMode.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FConnectionMetaData.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionMetaData.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="ConnectionMetaData.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ConnectionMetaData.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,259 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
DeliveryMode (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.DeliveryMode interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="DeliveryMode (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="DeliveryMode.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ConnectionMetaData.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Destination.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FDeliveryMode.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="DeliveryMode.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 | <A HREF="DeliveryMode.html#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="DeliveryMode.html#field_detail">FIELD</A> | 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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface DeliveryMode</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>DeliveryMode</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The delivery modes supported by the JMS API are <CODE>PERSISTENT</CODE> and
|
||||
<CODE>NON_PERSISTENT</CODE>.
|
||||
|
||||
<P>A client marks a message as persistent if it feels that the
|
||||
application will have problems if the message is lost in transit.
|
||||
A client marks a message as non-persistent if an occasional
|
||||
lost message is tolerable. Clients use delivery mode to tell a
|
||||
JMS provider how to balance message transport reliability with throughput.
|
||||
|
||||
<P>Delivery mode covers only the transport of the message to its
|
||||
destination. Retention of a message at the destination until
|
||||
its receipt is acknowledged is not guaranteed by a <CODE>PERSISTENT</CODE>
|
||||
delivery mode. Clients should assume that message retention
|
||||
policies are set administratively. Message retention policy
|
||||
governs the reliability of message delivery from destination
|
||||
to message consumer. For example, if a client's message storage
|
||||
space is exhausted, some messages may be dropped in accordance with
|
||||
a site-specific message retention policy.
|
||||
|
||||
<P>A message is guaranteed to be delivered once and only once
|
||||
by a JMS provider if the delivery mode of the message is
|
||||
<CODE>PERSISTENT</CODE>
|
||||
and if the destination has a sufficient message retention policy.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="DeliveryMode.html#NON_PERSISTENT">NON_PERSISTENT</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
This is the lowest-overhead delivery mode because it does not require
|
||||
that the message be logged to stable storage.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="DeliveryMode.html#PERSISTENT">PERSISTENT</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
This delivery mode instructs the JMS provider to log the message to stable
|
||||
storage as part of the client's send operation.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
<A NAME="field_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>Field Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="NON_PERSISTENT"><!-- --></A><H3>
|
||||
NON_PERSISTENT</H3>
|
||||
<PRE>
|
||||
static final int <B>NON_PERSISTENT</B></PRE>
|
||||
<DL>
|
||||
<DD>This is the lowest-overhead delivery mode because it does not require
|
||||
that the message be logged to stable storage. The level of JMS provider
|
||||
failure that causes a <CODE>NON_PERSISTENT</CODE> message to be lost is
|
||||
not defined.
|
||||
|
||||
<P>A JMS provider must deliver a <CODE>NON_PERSISTENT</CODE> message
|
||||
with an
|
||||
at-most-once guarantee. This means that it may lose the message, but it
|
||||
must not deliver it twice.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.jms.DeliveryMode.NON_PERSISTENT">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="PERSISTENT"><!-- --></A><H3>
|
||||
PERSISTENT</H3>
|
||||
<PRE>
|
||||
static final int <B>PERSISTENT</B></PRE>
|
||||
<DL>
|
||||
<DD>This delivery mode instructs the JMS provider to log the message to stable
|
||||
storage as part of the client's send operation. Only a hard media
|
||||
failure should cause a <CODE>PERSISTENT</CODE> message to be lost.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.jms.DeliveryMode.PERSISTENT">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="DeliveryMode.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ConnectionMetaData.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Destination.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FDeliveryMode.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="DeliveryMode.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 | <A HREF="DeliveryMode.html#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="DeliveryMode.html#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,232 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
Destination (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.Destination interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="Destination (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="Destination.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="DeliveryMode.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ExceptionListener.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FDestination.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Destination.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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface Destination</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="Queue.html" title="interface in javax.jms">Queue</A>, <A HREF="TemporaryQueue.html" title="interface in javax.jms">TemporaryQueue</A>, <A HREF="TemporaryTopic.html" title="interface in javax.jms">TemporaryTopic</A>, <A HREF="Topic.html" title="interface in javax.jms">Topic</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>Destination</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>Destination</CODE> object encapsulates a provider-specific
|
||||
address.
|
||||
The JMS API does not define a standard address syntax. Although a standard
|
||||
address syntax was considered, it was decided that the differences in
|
||||
address semantics between existing message-oriented middleware (MOM)
|
||||
products were too wide to bridge with a single syntax.
|
||||
|
||||
<P>Since <CODE>Destination</CODE> is an administered object, it may
|
||||
contain
|
||||
provider-specific configuration information in addition to its address.
|
||||
|
||||
<P>The JMS API also supports a client's use of provider-specific address
|
||||
names.
|
||||
|
||||
<P><CODE>Destination</CODE> objects support concurrent use.
|
||||
|
||||
<P>A <CODE>Destination</CODE> object is a JMS administered object.
|
||||
|
||||
<P>JMS administered objects are objects containing configuration
|
||||
information that are created by an administrator and later used by
|
||||
JMS clients. They make it practical to administer the JMS API in the
|
||||
enterprise.
|
||||
|
||||
<P>Although the interfaces for administered objects do not explicitly
|
||||
depend on the Java Naming and Directory Interface (JNDI) API, the JMS API
|
||||
establishes the convention that JMS clients find administered objects by
|
||||
looking them up in a JNDI namespace.
|
||||
|
||||
<P>An administrator can place an administered object anywhere in a
|
||||
namespace. The JMS API does not define a naming policy.
|
||||
|
||||
<P>It is expected that JMS providers will provide the tools an
|
||||
administrator needs to create and configure administered objects in a
|
||||
JNDI namespace. JMS provider implementations of administered objects
|
||||
should implement the <CODE>javax.naming.Referenceable</CODE> and
|
||||
<CODE>java.io.Serializable</CODE> interfaces so that they can be stored in
|
||||
all JNDI naming contexts. In addition, it is recommended that these
|
||||
implementations follow the JavaBeans<SUP><FONT SIZE="-2">TM</FONT></SUP>
|
||||
design patterns.
|
||||
|
||||
<P>This strategy provides several benefits:
|
||||
|
||||
<UL>
|
||||
<LI>It hides provider-specific details from JMS clients.
|
||||
<LI>It abstracts JMS administrative information into objects in the Java
|
||||
programming language ("Java objects")
|
||||
that are easily organized and administered from a common
|
||||
management console.
|
||||
<LI>Since there will be JNDI providers for all popular naming
|
||||
services, JMS providers can deliver one implementation
|
||||
of administered objects that will run everywhere.
|
||||
</UL>
|
||||
|
||||
<P>An administered object should not hold on to any remote resources.
|
||||
Its lookup should not use remote resources other than those used by the
|
||||
JNDI API itself.
|
||||
|
||||
<P>Clients should think of administered objects as local Java objects.
|
||||
Looking them up should not have any hidden side effects or use surprising
|
||||
amounts of local resources.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Queue.html" title="interface in javax.jms"><CODE>Queue</CODE></A>,
|
||||
<A HREF="Topic.html" title="interface in javax.jms"><CODE>Topic</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="Destination.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="DeliveryMode.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ExceptionListener.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FDestination.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Destination.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>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,220 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
ExceptionListener (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ExceptionListener interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ExceptionListener (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ExceptionListener.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Destination.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="IllegalStateException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FExceptionListener.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ExceptionListener.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="ExceptionListener.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ExceptionListener.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ExceptionListener</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ExceptionListener</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
If a JMS provider detects a serious problem with a <CODE>Connection</CODE>
|
||||
object, it informs the <CODE>Connection</CODE> object'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> argument 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 that their connection has failed.
|
||||
|
||||
<P>A JMS provider should attempt to resolve connection problems
|
||||
itself before it notifies the client of them.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)"><CODE>Connection.setExceptionListener(ExceptionListener)</CODE></A></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="ExceptionListener.html#onException(javax.jms.JMSException)">onException</A></B>(<A HREF="JMSException.html" title="class in javax.jms">JMSException</A> exception)</CODE>
|
||||
|
||||
<BR>
|
||||
Notifies user of a JMS exception.</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="onException(javax.jms.JMSException)"><!-- --></A><H3>
|
||||
onException</H3>
|
||||
<PRE>
|
||||
void <B>onException</B>(<A HREF="JMSException.html" title="class in javax.jms">JMSException</A> exception)</PRE>
|
||||
<DL>
|
||||
<DD>Notifies user of a JMS exception.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>exception</CODE> - the JMS exception</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ExceptionListener.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Destination.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="IllegalStateException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FExceptionListener.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ExceptionListener.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="ExceptionListener.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ExceptionListener.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,284 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
IllegalStateException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.IllegalStateException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="IllegalStateException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="IllegalStateException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ExceptionListener.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="InvalidClientIDException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FIllegalStateException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="IllegalStateException.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="IllegalStateException.html#constructor_summary">CONSTR</A> | <A HREF="IllegalStateException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="IllegalStateException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class IllegalStateException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.IllegalStateException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>IllegalStateException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception is thrown when a method is
|
||||
invoked at an illegal or inappropriate time or if the provider is
|
||||
not in an appropriate state for the requested operation. For example,
|
||||
this exception must be thrown if <CODE>Session.commit</CODE> is
|
||||
called on a non-transacted session. This exception is also called when
|
||||
a domain inappropriate method is called, such as calling
|
||||
<CODE>TopicSession.CreateQueueBrowser</CODE>.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.IllegalStateException">Serialized Form</A></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="IllegalStateException.html#IllegalStateException(java.lang.String)">IllegalStateException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>IllegalStateException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="IllegalStateException.html#IllegalStateException(java.lang.String, java.lang.String)">IllegalStateException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>IllegalStateException</CODE> with the specified reason
|
||||
and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="IllegalStateException(java.lang.String)"><!-- --></A><H3>
|
||||
IllegalStateException</H3>
|
||||
<PRE>
|
||||
public <B>IllegalStateException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>IllegalStateException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="IllegalStateException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
IllegalStateException</H3>
|
||||
<PRE>
|
||||
public <B>IllegalStateException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>IllegalStateException</CODE> with the specified reason
|
||||
and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="IllegalStateException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ExceptionListener.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="InvalidClientIDException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FIllegalStateException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="IllegalStateException.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="IllegalStateException.html#constructor_summary">CONSTR</A> | <A HREF="IllegalStateException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="IllegalStateException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
InvalidClientIDException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.InvalidClientIDException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="InvalidClientIDException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="InvalidClientIDException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="IllegalStateException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="InvalidDestinationException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FInvalidClientIDException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="InvalidClientIDException.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="InvalidClientIDException.html#constructor_summary">CONSTR</A> | <A HREF="InvalidClientIDException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="InvalidClientIDException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class InvalidClientIDException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.InvalidClientIDException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>InvalidClientIDException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a
|
||||
client attempts to set a connection's client ID to a value that
|
||||
is rejected by a provider.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.InvalidClientIDException">Serialized Form</A></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="InvalidClientIDException.html#InvalidClientIDException(java.lang.String)">InvalidClientIDException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>InvalidClientIDException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="InvalidClientIDException.html#InvalidClientIDException(java.lang.String, java.lang.String)">InvalidClientIDException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>InvalidClientIDException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="InvalidClientIDException(java.lang.String)"><!-- --></A><H3>
|
||||
InvalidClientIDException</H3>
|
||||
<PRE>
|
||||
public <B>InvalidClientIDException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>InvalidClientIDException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="InvalidClientIDException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
InvalidClientIDException</H3>
|
||||
<PRE>
|
||||
public <B>InvalidClientIDException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>InvalidClientIDException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="InvalidClientIDException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="IllegalStateException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="InvalidDestinationException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FInvalidClientIDException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="InvalidClientIDException.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="InvalidClientIDException.html#constructor_summary">CONSTR</A> | <A HREF="InvalidClientIDException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="InvalidClientIDException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
InvalidDestinationException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.InvalidDestinationException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="InvalidDestinationException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="InvalidDestinationException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="InvalidClientIDException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="InvalidSelectorException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FInvalidDestinationException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="InvalidDestinationException.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="InvalidDestinationException.html#constructor_summary">CONSTR</A> | <A HREF="InvalidDestinationException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="InvalidDestinationException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class InvalidDestinationException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.InvalidDestinationException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>InvalidDestinationException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a
|
||||
destination either is not understood by a provider or is no
|
||||
longer valid.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.InvalidDestinationException">Serialized Form</A></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="InvalidDestinationException.html#InvalidDestinationException(java.lang.String)">InvalidDestinationException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>InvalidDestinationException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="InvalidDestinationException.html#InvalidDestinationException(java.lang.String, java.lang.String)">InvalidDestinationException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>InvalidDestinationException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="InvalidDestinationException(java.lang.String)"><!-- --></A><H3>
|
||||
InvalidDestinationException</H3>
|
||||
<PRE>
|
||||
public <B>InvalidDestinationException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>InvalidDestinationException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="InvalidDestinationException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
InvalidDestinationException</H3>
|
||||
<PRE>
|
||||
public <B>InvalidDestinationException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>InvalidDestinationException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="InvalidDestinationException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="InvalidClientIDException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="InvalidSelectorException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FInvalidDestinationException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="InvalidDestinationException.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="InvalidDestinationException.html#constructor_summary">CONSTR</A> | <A HREF="InvalidDestinationException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="InvalidDestinationException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
InvalidSelectorException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.InvalidSelectorException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="InvalidSelectorException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="InvalidSelectorException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="InvalidDestinationException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="JMSException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FInvalidSelectorException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="InvalidSelectorException.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="InvalidSelectorException.html#constructor_summary">CONSTR</A> | <A HREF="InvalidSelectorException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="InvalidSelectorException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class InvalidSelectorException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.InvalidSelectorException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>InvalidSelectorException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a
|
||||
JMS client attempts to give a provider a message selector with
|
||||
invalid syntax.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.InvalidSelectorException">Serialized Form</A></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="InvalidSelectorException.html#InvalidSelectorException(java.lang.String)">InvalidSelectorException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>InvalidSelectorException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="InvalidSelectorException.html#InvalidSelectorException(java.lang.String, java.lang.String)">InvalidSelectorException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs an <CODE>InvalidSelectorException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="InvalidSelectorException(java.lang.String)"><!-- --></A><H3>
|
||||
InvalidSelectorException</H3>
|
||||
<PRE>
|
||||
public <B>InvalidSelectorException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>InvalidSelectorException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="InvalidSelectorException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
InvalidSelectorException</H3>
|
||||
<PRE>
|
||||
public <B>InvalidSelectorException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs an <CODE>InvalidSelectorException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="InvalidSelectorException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="InvalidDestinationException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="JMSException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FInvalidSelectorException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="InvalidSelectorException.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="InvalidSelectorException.html#constructor_summary">CONSTR</A> | <A HREF="InvalidSelectorException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="InvalidSelectorException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,357 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
JMSException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.JMSException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="JMSException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="JMSException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="InvalidSelectorException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="JMSSecurityException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FJMSException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="JMSException.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="JMSException.html#constructor_summary">CONSTR</A> | <A HREF="JMSException.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="JMSException.html#constructor_detail">CONSTR</A> | <A HREF="JMSException.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class JMSException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.JMSException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="IllegalStateException.html" title="class in javax.jms">IllegalStateException</A>, <A HREF="InvalidClientIDException.html" title="class in javax.jms">InvalidClientIDException</A>, <A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A>, <A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A>, <A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A>, <A HREF="MessageEOFException.html" title="class in javax.jms">MessageEOFException</A>, <A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A>, <A HREF="MessageNotReadableException.html" title="class in javax.jms">MessageNotReadableException</A>, <A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A>, <A HREF="ResourceAllocationException.html" title="class in javax.jms">ResourceAllocationException</A>, <A HREF="TransactionInProgressException.html" title="class in javax.jms">TransactionInProgressException</A>, <A HREF="TransactionRolledBackException.html" title="class in javax.jms">TransactionRolledBackException</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>JMSException</B><DT>extends java.lang.Exception</DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P>This is the root class of all JMS API exceptions.
|
||||
|
||||
<P>It provides the following information:
|
||||
<UL>
|
||||
<LI> A provider-specific string describing the error. This string is
|
||||
the standard exception message and is available via the
|
||||
<CODE>getMessage</CODE> method.
|
||||
<LI> A provider-specific string error code
|
||||
<LI> A reference to another exception. Often a JMS API exception will
|
||||
be the result of a lower-level problem. If appropriate, this
|
||||
lower-level exception can be linked to the JMS API exception.
|
||||
</UL>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.JMSException">Serialized Form</A></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="JMSException.html#JMSException(java.lang.String)">JMSException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>JMSException</CODE> with the specified reason and with
|
||||
the error code defaulting to null.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="JMSException.html#JMSException(java.lang.String, java.lang.String)">JMSException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>JMSException</CODE> with the specified reason and
|
||||
error code.</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> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="JMSException.html#getErrorCode()">getErrorCode</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the vendor-specific error code.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.Exception</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="JMSException.html#getLinkedException()">getLinkedException</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the exception linked to this one.</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="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></B>(java.lang.Exception ex)</CODE>
|
||||
|
||||
<BR>
|
||||
Adds a linked <CODE>Exception</CODE>.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="JMSException(java.lang.String)"><!-- --></A><H3>
|
||||
JMSException</H3>
|
||||
<PRE>
|
||||
public <B>JMSException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>JMSException</CODE> with the specified reason and with
|
||||
the error code defaulting to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="JMSException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
JMSException</H3>
|
||||
<PRE>
|
||||
public <B>JMSException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>JMSException</CODE> with the specified reason and
|
||||
error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</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="getErrorCode()"><!-- --></A><H3>
|
||||
getErrorCode</H3>
|
||||
<PRE>
|
||||
public java.lang.String <B>getErrorCode</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Gets the vendor-specific error code.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLinkedException()"><!-- --></A><H3>
|
||||
getLinkedException</H3>
|
||||
<PRE>
|
||||
public java.lang.Exception <B>getLinkedException</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Gets the exception linked to this one.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the linked <CODE>Exception</CODE>, null if none</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLinkedException(java.lang.Exception)"><!-- --></A><H3>
|
||||
setLinkedException</H3>
|
||||
<PRE>
|
||||
public void <B>setLinkedException</B>(java.lang.Exception ex)</PRE>
|
||||
<DL>
|
||||
<DD>Adds a linked <CODE>Exception</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>ex</CODE> - the linked <CODE>Exception</CODE></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="JMSException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="InvalidSelectorException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="JMSSecurityException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FJMSException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="JMSException.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="JMSException.html#constructor_summary">CONSTR</A> | <A HREF="JMSException.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="JMSException.html#constructor_detail">CONSTR</A> | <A HREF="JMSException.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
||||
<TITLE>
|
||||
JMSSecurityException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.JMSSecurityException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="JMSSecurityException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="JMSSecurityException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="JMSException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MapMessage.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FJMSSecurityException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="JMSSecurityException.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="JMSSecurityException.html#constructor_summary">CONSTR</A> | <A HREF="JMSSecurityException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="JMSSecurityException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class JMSSecurityException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.JMSSecurityException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>JMSSecurityException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a provider rejects a user
|
||||
name/password submitted by a client. It may also be thrown for any case
|
||||
where a security restriction prevents a method from completing.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.JMSSecurityException">Serialized Form</A></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="JMSSecurityException.html#JMSSecurityException(java.lang.String)">JMSSecurityException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>JMSSecurityException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="JMSSecurityException.html#JMSSecurityException(java.lang.String, java.lang.String)">JMSSecurityException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>JMSSecurityException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="JMSSecurityException(java.lang.String)"><!-- --></A><H3>
|
||||
JMSSecurityException</H3>
|
||||
<PRE>
|
||||
public <B>JMSSecurityException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>JMSSecurityException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="JMSSecurityException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
JMSSecurityException</H3>
|
||||
<PRE>
|
||||
public <B>JMSSecurityException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>JMSSecurityException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="JMSSecurityException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="JMSException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MapMessage.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FJMSSecurityException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="JMSSecurityException.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="JMSSecurityException.html#constructor_summary">CONSTR</A> | <A HREF="JMSSecurityException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="JMSSecurityException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,441 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageConsumer (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageConsumer interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageConsumer (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageConsumer.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Message.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageEOFException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageConsumer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageConsumer.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="MessageConsumer.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="MessageConsumer.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface MessageConsumer</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="QueueReceiver.html" title="interface in javax.jms">QueueReceiver</A>, <A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>MessageConsumer</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>MessageConsumer</CODE> object to receive messages
|
||||
from a destination. A <CODE>MessageConsumer</CODE> object is created by
|
||||
passing a <CODE>Destination</CODE> object to a message-consumer creation
|
||||
method supplied by a session.
|
||||
|
||||
<P><CODE>MessageConsumer</CODE> is the parent interface for all message
|
||||
consumers.
|
||||
|
||||
<P>A message consumer can be created with a message selector. A message
|
||||
selector allows
|
||||
the client to restrict the messages delivered to the message consumer to
|
||||
those that match the selector.
|
||||
|
||||
<P>A client may either synchronously receive a message consumer's messages
|
||||
or have the consumer asynchronously deliver them as they arrive.
|
||||
|
||||
<P>For synchronous receipt, a client can request the next message from a
|
||||
message consumer using one of its <CODE>receive</CODE> methods. There are
|
||||
several variations of <CODE>receive</CODE> that allow a
|
||||
client to poll or wait for the next message.
|
||||
|
||||
<P>For asynchronous delivery, a client can register a
|
||||
<CODE>MessageListener</CODE> object with a message consumer.
|
||||
As messages arrive at the message consumer, it delivers them by calling the
|
||||
<CODE>MessageListener</CODE>'s <CODE>onMessage</CODE> method.
|
||||
|
||||
<P>It is a client programming error for a <CODE>MessageListener</CODE> to
|
||||
throw an exception.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="QueueReceiver.html" title="interface in javax.jms"><CODE>QueueReceiver</CODE></A>,
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms"><CODE>TopicSubscriber</CODE></A>,
|
||||
<A HREF="Session.html" title="interface in javax.jms"><CODE>Session</CODE></A></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="MessageConsumer.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the message consumer.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="MessageListener.html" title="interface in javax.jms">MessageListener</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageConsumer.html#getMessageListener()">getMessageListener</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the message consumer's <CODE>MessageListener</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageConsumer.html#getMessageSelector()">getMessageSelector</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets this message consumer's message selector expression.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Message.html" title="interface in javax.jms">Message</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageConsumer.html#receive()">receive</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Receives the next message produced for this message consumer.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Message.html" title="interface in javax.jms">Message</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageConsumer.html#receive(long)">receive</A></B>(long timeout)</CODE>
|
||||
|
||||
<BR>
|
||||
Receives the next message that arrives within the specified
|
||||
timeout interval.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Message.html" title="interface in javax.jms">Message</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageConsumer.html#receiveNoWait()">receiveNoWait</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Receives the next message if one is immediately available.</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="MessageConsumer.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A></B>(<A HREF="MessageListener.html" title="interface in javax.jms">MessageListener</A> listener)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the message consumer's <CODE>MessageListener</CODE>.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Closes the message consumer.
|
||||
|
||||
<P>Since a provider may allocate some resources on behalf of a
|
||||
<CODE>MessageConsumer</CODE> outside the Java virtual machine, clients
|
||||
should close them when they
|
||||
are not needed. Relying on garbage collection to eventually reclaim
|
||||
these resources may not be timely enough.
|
||||
|
||||
<P>This call blocks until a <CODE>receive</CODE> or message listener in
|
||||
progress has completed. A blocked message consumer <CODE>receive</CODE>
|
||||
call
|
||||
returns null when this message consumer is closed.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to close the consumer
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getMessageListener()"><!-- --></A><H3>
|
||||
getMessageListener</H3>
|
||||
<PRE>
|
||||
<A HREF="MessageListener.html" title="interface in javax.jms">MessageListener</A> <B>getMessageListener</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the message consumer's <CODE>MessageListener</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the listener for the message consumer, or null if no listener
|
||||
is set
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the message
|
||||
listener due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageConsumer.html#setMessageListener(javax.jms.MessageListener)"><CODE>setMessageListener(javax.jms.MessageListener)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getMessageSelector()"><!-- --></A><H3>
|
||||
getMessageSelector</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getMessageSelector</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets this message consumer's message selector expression.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this message consumer's message selector, or null if no
|
||||
message selector exists for the message consumer (that is, if
|
||||
the message selector was not set or was set to null or the
|
||||
empty string)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the message
|
||||
selector due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="receive()"><!-- --></A><H3>
|
||||
receive</H3>
|
||||
<PRE>
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> <B>receive</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Receives the next message produced for this message consumer.
|
||||
|
||||
<P>This call blocks indefinitely until a message is produced
|
||||
or until this message consumer is closed.
|
||||
|
||||
<P>If this <CODE>receive</CODE> is done within a transaction, the
|
||||
consumer retains the message until the transaction commits.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the next message produced for this message consumer, or
|
||||
null if this message consumer is concurrently closed
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to receive the next
|
||||
message due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="receive(long)"><!-- --></A><H3>
|
||||
receive</H3>
|
||||
<PRE>
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> <B>receive</B>(long timeout)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Receives the next message that arrives within the specified
|
||||
timeout interval.
|
||||
|
||||
<P>This call blocks until a message arrives, the
|
||||
timeout expires, or this message consumer is closed.
|
||||
A <CODE>timeout</CODE> of zero never expires, and the call blocks
|
||||
indefinitely.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the timeout value (in milliseconds)
|
||||
<DT><B>Returns:</B><DD>the next message produced for this message consumer, or
|
||||
null if the timeout expires or this message consumer is concurrently
|
||||
closed
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to receive the next
|
||||
message due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="receiveNoWait()"><!-- --></A><H3>
|
||||
receiveNoWait</H3>
|
||||
<PRE>
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> <B>receiveNoWait</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Receives the next message if one is immediately available.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the next message produced for this message consumer, or
|
||||
null if one is not available
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to receive the next
|
||||
message due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setMessageListener(javax.jms.MessageListener)"><!-- --></A><H3>
|
||||
setMessageListener</H3>
|
||||
<PRE>
|
||||
void <B>setMessageListener</B>(<A HREF="MessageListener.html" title="interface in javax.jms">MessageListener</A> listener)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the message consumer's <CODE>MessageListener</CODE>.
|
||||
|
||||
<P>Setting the message listener to null is the equivalent of
|
||||
unsetting the message listener for the message consumer.
|
||||
|
||||
<P>The effect of calling <CODE>MessageConsumer.setMessageListener</CODE>
|
||||
while messages are being consumed by an existing listener
|
||||
or the consumer is being used to consume messages synchronously
|
||||
is undefined.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to which the messages are to be
|
||||
delivered
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set the message
|
||||
listener due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageConsumer.html#getMessageListener()"><CODE>getMessageListener()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageConsumer.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Message.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageEOFException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageConsumer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageConsumer.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="MessageConsumer.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="MessageConsumer.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageEOFException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageEOFException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageEOFException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageEOFException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageConsumer.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageFormatException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageEOFException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageEOFException.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="MessageEOFException.html#constructor_summary">CONSTR</A> | <A HREF="MessageEOFException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageEOFException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class MessageEOFException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.MessageEOFException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>MessageEOFException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when an unexpected
|
||||
end of stream has been reached when a <CODE>StreamMessage</CODE> or
|
||||
<CODE>BytesMessage</CODE> is being read.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.MessageEOFException">Serialized Form</A></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="MessageEOFException.html#MessageEOFException(java.lang.String)">MessageEOFException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageEOFException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="MessageEOFException.html#MessageEOFException(java.lang.String, java.lang.String)">MessageEOFException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageEOFException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="MessageEOFException(java.lang.String)"><!-- --></A><H3>
|
||||
MessageEOFException</H3>
|
||||
<PRE>
|
||||
public <B>MessageEOFException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageEOFException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="MessageEOFException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
MessageEOFException</H3>
|
||||
<PRE>
|
||||
public <B>MessageEOFException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageEOFException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageEOFException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageConsumer.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageFormatException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageEOFException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageEOFException.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="MessageEOFException.html#constructor_summary">CONSTR</A> | <A HREF="MessageEOFException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageEOFException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,288 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageFormatException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageFormatException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageFormatException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageFormatException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageEOFException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageListener.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageFormatException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageFormatException.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="MessageFormatException.html#constructor_summary">CONSTR</A> | <A HREF="MessageFormatException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageFormatException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class MessageFormatException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.MessageFormatException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>MessageFormatException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a JMS client
|
||||
attempts to use a data type not supported by a message or attempts to
|
||||
read data in a message as the wrong type. It must also be thrown when
|
||||
equivalent type errors are made with message property values. For
|
||||
example, this exception must be thrown if
|
||||
<CODE>StreamMessage.writeObject</CODE> is given an unsupported class or
|
||||
if <CODE>StreamMessage.readShort</CODE> is used to read a
|
||||
<CODE>boolean</CODE> value. Note that the special case of a failure
|
||||
caused by an attempt to read improperly formatted <CODE>String</CODE>
|
||||
data as numeric values must throw the
|
||||
<CODE>java.lang.NumberFormatException</CODE>.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.MessageFormatException">Serialized Form</A></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="MessageFormatException.html#MessageFormatException(java.lang.String)">MessageFormatException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageFormatException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="MessageFormatException.html#MessageFormatException(java.lang.String, java.lang.String)">MessageFormatException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageFormatException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="MessageFormatException(java.lang.String)"><!-- --></A><H3>
|
||||
MessageFormatException</H3>
|
||||
<PRE>
|
||||
public <B>MessageFormatException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageFormatException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="MessageFormatException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
MessageFormatException</H3>
|
||||
<PRE>
|
||||
public <B>MessageFormatException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageFormatException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageFormatException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageEOFException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageListener.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageFormatException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageFormatException.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="MessageFormatException.html#constructor_summary">CONSTR</A> | <A HREF="MessageFormatException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageFormatException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,214 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageListener (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageListener interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageListener (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageListener.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageFormatException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageNotReadableException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageListener.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageListener.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="MessageListener.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="MessageListener.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface MessageListener</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>MessageListener</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>MessageListener</CODE> object is used to receive asynchronously
|
||||
delivered messages.
|
||||
|
||||
<P>Each session must insure that it passes messages serially to the
|
||||
listener. This means that a listener assigned to one or more consumers
|
||||
of the same session can assume that the <CODE>onMessage</CODE> method
|
||||
is not called with the next message until the session has completed the
|
||||
last call.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageListener.html#onMessage(javax.jms.Message)">onMessage</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Passes a message to the listener.</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="onMessage(javax.jms.Message)"><!-- --></A><H3>
|
||||
onMessage</H3>
|
||||
<PRE>
|
||||
void <B>onMessage</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</PRE>
|
||||
<DL>
|
||||
<DD>Passes a message to the listener.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message passed to the listener</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageListener.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageFormatException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageNotReadableException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageListener.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageListener.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="MessageListener.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="MessageListener.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,279 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageNotReadableException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageNotReadableException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageNotReadableException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageNotReadableException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageListener.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageNotWriteableException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageNotReadableException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageNotReadableException.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="MessageNotReadableException.html#constructor_summary">CONSTR</A> | <A HREF="MessageNotReadableException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageNotReadableException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class MessageNotReadableException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.MessageNotReadableException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>MessageNotReadableException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a JMS client attempts to read a
|
||||
write-only message.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.MessageNotReadableException">Serialized Form</A></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="MessageNotReadableException.html#MessageNotReadableException(java.lang.String)">MessageNotReadableException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageNotReadableException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="MessageNotReadableException.html#MessageNotReadableException(java.lang.String, java.lang.String)">MessageNotReadableException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageNotReadableException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="MessageNotReadableException(java.lang.String)"><!-- --></A><H3>
|
||||
MessageNotReadableException</H3>
|
||||
<PRE>
|
||||
public <B>MessageNotReadableException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageNotReadableException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="MessageNotReadableException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
MessageNotReadableException</H3>
|
||||
<PRE>
|
||||
public <B>MessageNotReadableException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageNotReadableException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageNotReadableException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageListener.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageNotWriteableException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageNotReadableException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageNotReadableException.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="MessageNotReadableException.html#constructor_summary">CONSTR</A> | <A HREF="MessageNotReadableException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageNotReadableException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,279 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageNotWriteableException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageNotWriteableException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageNotWriteableException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageNotWriteableException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageNotReadableException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageNotWriteableException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageNotWriteableException.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="MessageNotWriteableException.html#constructor_summary">CONSTR</A> | <A HREF="MessageNotWriteableException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageNotWriteableException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class MessageNotWriteableException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.MessageNotWriteableException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>MessageNotWriteableException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a JMS client attempts to write to a
|
||||
read-only message.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.MessageNotWriteableException">Serialized Form</A></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="MessageNotWriteableException.html#MessageNotWriteableException(java.lang.String)">MessageNotWriteableException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageNotWriteableException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="MessageNotWriteableException.html#MessageNotWriteableException(java.lang.String, java.lang.String)">MessageNotWriteableException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>MessageNotWriteableException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="MessageNotWriteableException(java.lang.String)"><!-- --></A><H3>
|
||||
MessageNotWriteableException</H3>
|
||||
<PRE>
|
||||
public <B>MessageNotWriteableException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageNotWriteableException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="MessageNotWriteableException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
MessageNotWriteableException</H3>
|
||||
<PRE>
|
||||
public <B>MessageNotWriteableException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>MessageNotWriteableException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageNotWriteableException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageNotReadableException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageNotWriteableException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageNotWriteableException.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="MessageNotWriteableException.html#constructor_summary">CONSTR</A> | <A HREF="MessageNotWriteableException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="MessageNotWriteableException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,748 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
MessageProducer (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.MessageProducer interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageProducer (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="MessageProducer.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageNotWriteableException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ObjectMessage.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageProducer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageProducer.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="MessageProducer.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="MessageProducer.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface MessageProducer</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="QueueSender.html" title="interface in javax.jms">QueueSender</A>, <A HREF="TopicPublisher.html" title="interface in javax.jms">TopicPublisher</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>MessageProducer</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>MessageProducer</CODE> object to send messages to a
|
||||
destination. A <CODE>MessageProducer</CODE> object is created by passing a
|
||||
<CODE>Destination</CODE> object to a message-producer creation method
|
||||
supplied by a session.
|
||||
|
||||
<P><CODE>MessageProducer</CODE> is the parent interface for all message
|
||||
producers.
|
||||
|
||||
<P>A client also has the option of creating a message producer without
|
||||
supplying a destination. In this case, a destination must be provided with
|
||||
every send operation. A typical use for this kind of message producer is
|
||||
to send replies to requests using the request's <CODE>JMSReplyTo</CODE>
|
||||
destination.
|
||||
|
||||
<P>A client can specify a default delivery mode, priority, and time to live
|
||||
for messages sent by a message producer. It can also specify the delivery
|
||||
mode, priority, and time to live for an individual message.
|
||||
|
||||
<P>A client can specify a time-to-live value in milliseconds for each
|
||||
message it sends. This value defines a message expiration time that
|
||||
is the sum of the message's time-to-live and the GMT when it is sent (for
|
||||
transacted sends, this is the time the client sends the message, not
|
||||
the time the transaction is committed).
|
||||
|
||||
<P>A JMS provider should do its best to expire messages accurately;
|
||||
however, the JMS API does not define the accuracy provided.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="TopicPublisher.html" title="interface in javax.jms"><CODE>TopicPublisher</CODE></A>,
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms"><CODE>QueueSender</CODE></A>,
|
||||
<A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(javax.jms.Destination)</CODE></A></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="MessageProducer.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the message producer.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageProducer.html#getDeliveryMode()">getDeliveryMode</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the producer's default delivery mode.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Destination.html" title="interface in javax.jms">Destination</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageProducer.html#getDestination()">getDestination</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the destination associated with this <CODE>MessageProducer</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageProducer.html#getDisableMessageID()">getDisableMessageID</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets an indication of whether message IDs are disabled.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageProducer.html#getDisableMessageTimestamp()">getDisableMessageTimestamp</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets an indication of whether message timestamps are disabled.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageProducer.html#getPriority()">getPriority</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the producer's default priority.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> long</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="MessageProducer.html#getTimeToLive()">getTimeToLive</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the default length of time in milliseconds from its dispatch time
|
||||
that a produced message should be retained by the message system.</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="MessageProducer.html#send(javax.jms.Destination, javax.jms.Message)">send</A></B>(<A HREF="Destination.html" title="interface in javax.jms">Destination</A> destination,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to a destination for an unidentified message producer.</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="MessageProducer.html#send(javax.jms.Destination, javax.jms.Message, int, int, long)">send</A></B>(<A HREF="Destination.html" title="interface in javax.jms">Destination</A> destination,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to a destination for an unidentified message producer,
|
||||
specifying delivery mode, priority and time to live.</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="MessageProducer.html#send(javax.jms.Message)">send</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message using the <CODE>MessageProducer</CODE>'s
|
||||
default delivery mode, priority, and time to live.</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="MessageProducer.html#send(javax.jms.Message, int, int, long)">send</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to the destination, specifying delivery mode, priority, and
|
||||
time to live.</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="MessageProducer.html#setDeliveryMode(int)">setDeliveryMode</A></B>(int deliveryMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the producer's default delivery mode.</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="MessageProducer.html#setDisableMessageID(boolean)">setDisableMessageID</A></B>(boolean value)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets whether message IDs are disabled.</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="MessageProducer.html#setDisableMessageTimestamp(boolean)">setDisableMessageTimestamp</A></B>(boolean value)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets whether message timestamps are disabled.</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="MessageProducer.html#setPriority(int)">setPriority</A></B>(int defaultPriority)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the producer's default priority.</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="MessageProducer.html#setTimeToLive(long)">setTimeToLive</A></B>(long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the default length of time in milliseconds from its dispatch time
|
||||
that a produced message should be retained by the message system.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Closes the message producer.
|
||||
|
||||
<P>Since a provider may allocate some resources on behalf of a
|
||||
<CODE>MessageProducer</CODE> outside the Java virtual machine, clients
|
||||
should close them when they
|
||||
are not needed. Relying on garbage collection to eventually reclaim
|
||||
these resources may not be timely enough.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to close the producer
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getDeliveryMode()"><!-- --></A><H3>
|
||||
getDeliveryMode</H3>
|
||||
<PRE>
|
||||
int <B>getDeliveryMode</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the producer's default delivery mode.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the message delivery mode for this message producer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the delivery
|
||||
mode due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#setDeliveryMode(int)"><CODE>setDeliveryMode(int)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getDestination()"><!-- --></A><H3>
|
||||
getDestination</H3>
|
||||
<PRE>
|
||||
<A HREF="Destination.html" title="interface in javax.jms">Destination</A> <B>getDestination</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the destination associated with this <CODE>MessageProducer</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this producer's <CODE>Destination/<CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the destination for
|
||||
this <CODE>MessageProducer</CODE>
|
||||
due to some internal error.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getDisableMessageID()"><!-- --></A><H3>
|
||||
getDisableMessageID</H3>
|
||||
<PRE>
|
||||
boolean <B>getDisableMessageID</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets an indication of whether message IDs are disabled.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an indication of whether message IDs are disabled
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to determine if
|
||||
message IDs are disabled due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getDisableMessageTimestamp()"><!-- --></A><H3>
|
||||
getDisableMessageTimestamp</H3>
|
||||
<PRE>
|
||||
boolean <B>getDisableMessageTimestamp</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets an indication of whether message timestamps are disabled.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an indication of whether message timestamps are disabled
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to determine if
|
||||
timestamps are disabled due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPriority()"><!-- --></A><H3>
|
||||
getPriority</H3>
|
||||
<PRE>
|
||||
int <B>getPriority</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the producer's default priority.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the message priority for this message producer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the priority
|
||||
due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#setPriority(int)"><CODE>setPriority(int)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getTimeToLive()"><!-- --></A><H3>
|
||||
getTimeToLive</H3>
|
||||
<PRE>
|
||||
long <B>getTimeToLive</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the default length of time in milliseconds from its dispatch time
|
||||
that a produced message should be retained by the message system.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the message time to live in milliseconds; zero is unlimited
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the time to
|
||||
live due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#setTimeToLive(long)"><CODE>setTimeToLive(long)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Destination, javax.jms.Message)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Destination.html" title="interface in javax.jms">Destination</A> destination,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to a destination for an unidentified message producer.
|
||||
Uses the <CODE>MessageProducer</CODE>'s default delivery mode, priority,
|
||||
and time to live.
|
||||
|
||||
<P>Typically, a message producer is assigned a destination at creation
|
||||
time; however, the JMS API also supports unidentified message producers,
|
||||
which require that the destination be supplied every time a message is
|
||||
sent.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>destination</CODE> - the destination to send this message to<DD><CODE>message</CODE> - the message to send
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with an invalid destination.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>MessageProducer</CODE> that
|
||||
specified a destination at creation time.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(javax.jms.Destination)</CODE></A>,
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms"><CODE>MessageProducer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Destination, javax.jms.Message, int, int, long)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Destination.html" title="interface in javax.jms">Destination</A> destination,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to a destination for an unidentified message producer,
|
||||
specifying delivery mode, priority and time to live.
|
||||
|
||||
<P>Typically, a message producer is assigned a destination at creation
|
||||
time; however, the JMS API also supports unidentified message producers,
|
||||
which require that the destination be supplied every time a message is
|
||||
sent.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>destination</CODE> - the destination to send this message to<DD><CODE>message</CODE> - the message to send<DD><CODE>deliveryMode</CODE> - the delivery mode to use<DD><CODE>priority</CODE> - the priority for this message<DD><CODE>timeToLive</CODE> - the message's lifetime (in milliseconds)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with an invalid destination.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(javax.jms.Destination)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Message)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message using the <CODE>MessageProducer</CODE>'s
|
||||
default delivery mode, priority, and time to live.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with a <CODE>MessageProducer</CODE> with
|
||||
an invalid destination.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>MessageProducer</CODE> that did
|
||||
not specify a destination at creation time.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(javax.jms.Destination)</CODE></A>,
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms"><CODE>MessageProducer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Message, int, int, long)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to the destination, specifying delivery mode, priority, and
|
||||
time to live.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send<DD><CODE>deliveryMode</CODE> - the delivery mode to use<DD><CODE>priority</CODE> - the priority for this message<DD><CODE>timeToLive</CODE> - the message's lifetime (in milliseconds)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with a <CODE>MessageProducer</CODE> with
|
||||
an invalid destination.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>MessageProducer</CODE> that did
|
||||
not specify a destination at creation time.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(javax.jms.Destination)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setDeliveryMode(int)"><!-- --></A><H3>
|
||||
setDeliveryMode</H3>
|
||||
<PRE>
|
||||
void <B>setDeliveryMode</B>(int deliveryMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the producer's default delivery mode.
|
||||
|
||||
<P>Delivery mode is set to <CODE>PERSISTENT</CODE> by default.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>deliveryMode</CODE> - the message delivery mode for this message
|
||||
producer; legal values are <code>DeliveryMode.NON_PERSISTENT</code>
|
||||
and <code>DeliveryMode.PERSISTENT</code>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set the delivery
|
||||
mode due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getDeliveryMode()"><CODE>getDeliveryMode()</CODE></A>,
|
||||
<A HREF="DeliveryMode.html#NON_PERSISTENT"><CODE>DeliveryMode.NON_PERSISTENT</CODE></A>,
|
||||
<A HREF="DeliveryMode.html#PERSISTENT"><CODE>DeliveryMode.PERSISTENT</CODE></A>,
|
||||
<A HREF="Message.html#DEFAULT_DELIVERY_MODE"><CODE>Message.DEFAULT_DELIVERY_MODE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setDisableMessageID(boolean)"><!-- --></A><H3>
|
||||
setDisableMessageID</H3>
|
||||
<PRE>
|
||||
void <B>setDisableMessageID</B>(boolean value)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets whether message IDs are disabled.
|
||||
|
||||
<P>Since message IDs take some effort to create and increase a
|
||||
message's size, some JMS providers may be able to optimize message
|
||||
overhead if they are given a hint that the message ID is not used by
|
||||
an application. By calling the <CODE>setDisableMessageID</CODE>
|
||||
method on this message producer, a JMS client enables this potential
|
||||
optimization for all messages sent by this message producer. If the JMS
|
||||
provider accepts this hint,
|
||||
these messages must have the message ID set to null; if the provider
|
||||
ignores the hint, the message ID must be set to its normal unique value.
|
||||
|
||||
<P>Message IDs are enabled by default.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>value</CODE> - indicates if message IDs are disabled
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set message ID to
|
||||
disabled due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setDisableMessageTimestamp(boolean)"><!-- --></A><H3>
|
||||
setDisableMessageTimestamp</H3>
|
||||
<PRE>
|
||||
void <B>setDisableMessageTimestamp</B>(boolean value)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets whether message timestamps are disabled.
|
||||
|
||||
<P>Since timestamps take some effort to create and increase a
|
||||
message's size, some JMS providers may be able to optimize message
|
||||
overhead if they are given a hint that the timestamp is not used by an
|
||||
application. By calling the <CODE>setDisableMessageTimestamp</CODE>
|
||||
method on this message producer, a JMS client enables this potential
|
||||
optimization for all messages sent by this message producer. If the
|
||||
JMS provider accepts this hint,
|
||||
these messages must have the timestamp set to zero; if the provider
|
||||
ignores the hint, the timestamp must be set to its normal value.
|
||||
|
||||
<P>Message timestamps are enabled by default.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>value</CODE> - indicates if message timestamps are disabled
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set timestamps to
|
||||
disabled due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setPriority(int)"><!-- --></A><H3>
|
||||
setPriority</H3>
|
||||
<PRE>
|
||||
void <B>setPriority</B>(int defaultPriority)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the producer's default priority.
|
||||
|
||||
<P>The JMS API defines ten levels of priority value, with 0 as the
|
||||
lowest priority and 9 as the highest. Clients should consider priorities
|
||||
0-4 as gradations of normal priority and priorities 5-9 as gradations
|
||||
of expedited priority. Priority is set to 4 by default.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>defaultPriority</CODE> - the message priority for this message producer;
|
||||
must be a value between 0 and 9
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set the priority
|
||||
due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getPriority()"><CODE>getPriority()</CODE></A>,
|
||||
<A HREF="Message.html#DEFAULT_PRIORITY"><CODE>Message.DEFAULT_PRIORITY</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setTimeToLive(long)"><!-- --></A><H3>
|
||||
setTimeToLive</H3>
|
||||
<PRE>
|
||||
void <B>setTimeToLive</B>(long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the default length of time in milliseconds from its dispatch time
|
||||
that a produced message should be retained by the message system.
|
||||
|
||||
<P>Time to live is set to zero by default.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>timeToLive</CODE> - the message time to live in milliseconds; zero is
|
||||
unlimited
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set the time to
|
||||
live due to some internal error.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getTimeToLive()"><CODE>getTimeToLive()</CODE></A>,
|
||||
<A HREF="Message.html#DEFAULT_TIME_TO_LIVE"><CODE>Message.DEFAULT_TIME_TO_LIVE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="MessageProducer.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageNotWriteableException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ObjectMessage.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FMessageProducer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageProducer.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="MessageProducer.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="MessageProducer.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,303 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
ObjectMessage (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ObjectMessage interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ObjectMessage (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ObjectMessage.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Queue.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FObjectMessage.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ObjectMessage.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="ObjectMessage.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ObjectMessage.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ObjectMessage</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Message.html" title="interface in javax.jms">Message</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ObjectMessage</B><DT>extends <A HREF="Message.html" title="interface in javax.jms">Message</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>ObjectMessage</CODE> object is used to send a message that contains
|
||||
a serializable object in the Java programming language ("Java object").
|
||||
It inherits from the <CODE>Message</CODE> interface and adds a body
|
||||
containing a single reference to an object. Only <CODE>Serializable</CODE>
|
||||
Java objects can be used.
|
||||
|
||||
<P>If a collection of Java objects must be sent, one of the
|
||||
<CODE>Collection</CODE> classes provided since JDK 1.2 can be used.
|
||||
|
||||
<P>When a client receives an <CODE>ObjectMessage</CODE>, it is in read-only
|
||||
mode. If a client attempts to write to the message at this point, a
|
||||
<CODE>MessageNotWriteableException</CODE> is thrown. If
|
||||
<CODE>clearBody</CODE> is called, the message can now be both read from and
|
||||
written to.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createObjectMessage()"><CODE>Session.createObjectMessage()</CODE></A>,
|
||||
<A HREF="Session.html#createObjectMessage(java.io.Serializable)"><CODE>Session.createObjectMessage(Serializable)</CODE></A>,
|
||||
<A HREF="BytesMessage.html" title="interface in javax.jms"><CODE>BytesMessage</CODE></A>,
|
||||
<A HREF="MapMessage.html" title="interface in javax.jms"><CODE>MapMessage</CODE></A>,
|
||||
<A HREF="Message.html" title="interface in javax.jms"><CODE>Message</CODE></A>,
|
||||
<A HREF="StreamMessage.html" title="interface in javax.jms"><CODE>StreamMessage</CODE></A>,
|
||||
<A HREF="TextMessage.html" title="interface in javax.jms"><CODE>TextMessage</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Message"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Message.html" title="interface in javax.jms">Message</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Message.html#DEFAULT_DELIVERY_MODE">DEFAULT_DELIVERY_MODE</A>, <A HREF="Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</A>, <A HREF="Message.html#DEFAULT_TIME_TO_LIVE">DEFAULT_TIME_TO_LIVE</A></CODE></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> java.io.Serializable</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ObjectMessage.html#getObject()">getObject</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the serializable object containing this message's data.</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="ObjectMessage.html#setObject(java.io.Serializable)">setObject</A></B>(java.io.Serializable object)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the serializable object containing this message's data.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Message"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Message.html" title="interface in javax.jms">Message</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Message.html#acknowledge()">acknowledge</A>, <A HREF="Message.html#clearBody()">clearBody</A>, <A HREF="Message.html#clearProperties()">clearProperties</A>, <A HREF="Message.html#getBooleanProperty(java.lang.String)">getBooleanProperty</A>, <A HREF="Message.html#getByteProperty(java.lang.String)">getByteProperty</A>, <A HREF="Message.html#getDoubleProperty(java.lang.String)">getDoubleProperty</A>, <A HREF="Message.html#getFloatProperty(java.lang.String)">getFloatProperty</A>, <A HREF="Message.html#getIntProperty(java.lang.String)">getIntProperty</A>, <A HREF="Message.html#getJMSCorrelationID()">getJMSCorrelationID</A>, <A HREF="Message.html#getJMSCorrelationIDAsBytes()">getJMSCorrelationIDAsBytes</A>, <A HREF="Message.html#getJMSDeliveryMode()">getJMSDeliveryMode</A>, <A HREF="Message.html#getJMSDestination()">getJMSDestination</A>, <A HREF="Message.html#getJMSExpiration()">getJMSExpiration</A>, <A HREF="Message.html#getJMSMessageID()">getJMSMessageID</A>, <A HREF="Message.html#getJMSPriority()">getJMSPriority</A>, <A HREF="Message.html#getJMSRedelivered()">getJMSRedelivered</A>, <A HREF="Message.html#getJMSReplyTo()">getJMSReplyTo</A>, <A HREF="Message.html#getJMSTimestamp()">getJMSTimestamp</A>, <A HREF="Message.html#getJMSType()">getJMSType</A>, <A HREF="Message.html#getLongProperty(java.lang.String)">getLongProperty</A>, <A HREF="Message.html#getObjectProperty(java.lang.String)">getObjectProperty</A>, <A HREF="Message.html#getPropertyNames()">getPropertyNames</A>, <A HREF="Message.html#getShortProperty(java.lang.String)">getShortProperty</A>, <A HREF="Message.html#getStringProperty(java.lang.String)">getStringProperty</A>, <A HREF="Message.html#propertyExists(java.lang.String)">propertyExists</A>, <A HREF="Message.html#setBooleanProperty(java.lang.String, boolean)">setBooleanProperty</A>, <A HREF="Message.html#setByteProperty(java.lang.String, byte)">setByteProperty</A>, <A HREF="Message.html#setDoubleProperty(java.lang.String, double)">setDoubleProperty</A>, <A HREF="Message.html#setFloatProperty(java.lang.String, float)">setFloatProperty</A>, <A HREF="Message.html#setIntProperty(java.lang.String, int)">setIntProperty</A>, <A HREF="Message.html#setJMSCorrelationID(java.lang.String)">setJMSCorrelationID</A>, <A HREF="Message.html#setJMSCorrelationIDAsBytes(byte[])">setJMSCorrelationIDAsBytes</A>, <A HREF="Message.html#setJMSDeliveryMode(int)">setJMSDeliveryMode</A>, <A HREF="Message.html#setJMSDestination(javax.jms.Destination)">setJMSDestination</A>, <A HREF="Message.html#setJMSExpiration(long)">setJMSExpiration</A>, <A HREF="Message.html#setJMSMessageID(java.lang.String)">setJMSMessageID</A>, <A HREF="Message.html#setJMSPriority(int)">setJMSPriority</A>, <A HREF="Message.html#setJMSRedelivered(boolean)">setJMSRedelivered</A>, <A HREF="Message.html#setJMSReplyTo(javax.jms.Destination)">setJMSReplyTo</A>, <A HREF="Message.html#setJMSTimestamp(long)">setJMSTimestamp</A>, <A HREF="Message.html#setJMSType(java.lang.String)">setJMSType</A>, <A HREF="Message.html#setLongProperty(java.lang.String, long)">setLongProperty</A>, <A HREF="Message.html#setObjectProperty(java.lang.String, java.lang.Object)">setObjectProperty</A>, <A HREF="Message.html#setShortProperty(java.lang.String, short)">setShortProperty</A>, <A HREF="Message.html#setStringProperty(java.lang.String, java.lang.String)">setStringProperty</A></CODE></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="getObject()"><!-- --></A><H3>
|
||||
getObject</H3>
|
||||
<PRE>
|
||||
java.io.Serializable <B>getObject</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the serializable object containing this message's data. The
|
||||
default value is null.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the serializable object containing this message's data
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the object
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if object deserialization fails.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setObject(java.io.Serializable)"><!-- --></A><H3>
|
||||
setObject</H3>
|
||||
<PRE>
|
||||
void <B>setObject</B>(java.io.Serializable object)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the serializable object containing this message's data.
|
||||
It is important to note that an <CODE>ObjectMessage</CODE>
|
||||
contains a snapshot of the object at the time <CODE>setObject()</CODE>
|
||||
is called; subsequent modifications of the object will have no
|
||||
effect on the <CODE>ObjectMessage</CODE> body.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>object</CODE> - the message's data
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set the object
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if object serialization fails.
|
||||
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
||||
mode.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ObjectMessage.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Queue.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FObjectMessage.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ObjectMessage.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="ObjectMessage.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ObjectMessage.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,268 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
Queue (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.Queue interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="Queue (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="Queue.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ObjectMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueue.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Queue.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="Queue.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="Queue.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface Queue</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Destination.html" title="interface in javax.jms">Destination</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="TemporaryQueue.html" title="interface in javax.jms">TemporaryQueue</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>Queue</B><DT>extends <A HREF="Destination.html" title="interface in javax.jms">Destination</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>Queue</CODE> object encapsulates a provider-specific queue name.
|
||||
It is the way a client specifies the identity of a queue to JMS API methods.
|
||||
For those methods that use a <CODE>Destination</CODE> as a parameter, a
|
||||
<CODE>Queue</CODE> object used as an argument. For example, a queue can
|
||||
be used to create a <CODE>MessageConsumer</CODE> and a
|
||||
<CODE>MessageProducer</CODE> by calling:
|
||||
<UL>
|
||||
<LI> <CODE>Session.CreateConsumer(Destination destination)</CODE>
|
||||
<LI> <CODE>Session.CreateProducer(Destination destination)</CODE>
|
||||
|
||||
</UL>
|
||||
|
||||
<P>The actual length of time messages are held by a queue and the
|
||||
consequences of resource overflow are not defined by the JMS API.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createConsumer(javax.jms.Destination)"><CODE>Session.createConsumer(Destination)</CODE></A>,
|
||||
<A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(Destination)</CODE></A>,
|
||||
<A HREF="Session.html#createQueue(java.lang.String)"><CODE>Session.createQueue(String)</CODE></A>,
|
||||
<A HREF="QueueSession.html#createQueue(java.lang.String)"><CODE>QueueSession.createQueue(String)</CODE></A></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> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Queue.html#getQueueName()">getQueueName</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the name of this queue.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Queue.html#toString()">toString</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of this object.</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="getQueueName()"><!-- --></A><H3>
|
||||
getQueueName</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getQueueName</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the name of this queue.
|
||||
|
||||
<P>Clients that depend upon the name are not portable.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the queue name
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider implementation of
|
||||
<CODE>Queue</CODE> fails to return the queue
|
||||
name due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="toString()"><!-- --></A><H3>
|
||||
toString</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>toString</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of this object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the provider-specific identity values for this queue</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="Queue.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ObjectMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueue.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Queue.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="Queue.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="Queue.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,322 @@
|
||||
<!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_19) on Fri Aug 12 11:25:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueBrowser (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueBrowser interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueBrowser (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueBrowser.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Queue.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueBrowser.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueBrowser.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="QueueBrowser.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueBrowser.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface QueueBrowser</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>QueueBrowser</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>QueueBrowser</CODE> object to look at messages on a
|
||||
queue without removing them.
|
||||
|
||||
<P>The <CODE>getEnumeration</CODE> method returns a
|
||||
<CODE>java.util.Enumeration</CODE> that is used to scan
|
||||
the queue's messages. It may be an enumeration of the entire content of a
|
||||
queue, or it may contain only the messages matching a message selector.
|
||||
|
||||
<P>Messages may be arriving and expiring while the scan is done. The JMS API
|
||||
does
|
||||
not require the content of an enumeration to be a static snapshot of queue
|
||||
content. Whether these changes are visible or not depends on the JMS
|
||||
provider.
|
||||
|
||||
<P>A <CODE>QueueBrowser</CODE> can be created from either a
|
||||
<CODE>Session</CODE> or a <CODE> QueueSession</CODE>.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createBrowser(javax.jms.Queue)"><CODE>Session.createBrowser(javax.jms.Queue)</CODE></A>,
|
||||
<A HREF="QueueSession.html#createBrowser(javax.jms.Queue)"><CODE>QueueSession.createBrowser(javax.jms.Queue)</CODE></A>,
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms"><CODE>QueueReceiver</CODE></A></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="QueueBrowser.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the <CODE>QueueBrowser</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.util.Enumeration</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueBrowser.html#getEnumeration()">getEnumeration</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets an enumeration for browsing the current queue messages in the
|
||||
order they would be received.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueBrowser.html#getMessageSelector()">getMessageSelector</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets this queue browser's message selector expression.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Queue.html" title="interface in javax.jms">Queue</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueBrowser.html#getQueue()">getQueue</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the queue associated with this queue browser.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Closes the <CODE>QueueBrowser</CODE>.
|
||||
|
||||
<P>Since a provider may allocate some resources on behalf of a
|
||||
QueueBrowser outside the Java virtual machine, clients should close them
|
||||
when they
|
||||
are not needed. Relying on garbage collection to eventually reclaim
|
||||
these resources may not be timely enough.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to close this
|
||||
browser due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getEnumeration()"><!-- --></A><H3>
|
||||
getEnumeration</H3>
|
||||
<PRE>
|
||||
java.util.Enumeration <B>getEnumeration</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets an enumeration for browsing the current queue messages in the
|
||||
order they would be received.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an enumeration for browsing the messages
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the
|
||||
enumeration for this browser
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getMessageSelector()"><!-- --></A><H3>
|
||||
getMessageSelector</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getMessageSelector</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets this queue browser's message selector expression.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this queue browser's message selector, or null if no
|
||||
message selector exists for the message consumer (that is, if
|
||||
the message selector was not set or was set to null or the
|
||||
empty string)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the
|
||||
message selector for this browser
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getQueue()"><!-- --></A><H3>
|
||||
getQueue</H3>
|
||||
<PRE>
|
||||
<A HREF="Queue.html" title="interface in javax.jms">Queue</A> <B>getQueue</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the queue associated with this queue browser.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the queue
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the
|
||||
queue associated with this browser
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueBrowser.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Queue.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueBrowser.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueBrowser.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="QueueBrowser.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueBrowser.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,310 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueConnection (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueConnection interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueConnection (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueConnection.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="QueueConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueConnection.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface QueueConnection</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Connection.html" title="interface in javax.jms">Connection</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>QueueConnection</B><DT>extends <A HREF="Connection.html" title="interface in javax.jms">Connection</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>QueueConnection</CODE> object is an active connection to a
|
||||
point-to-point JMS provider. A client uses a <CODE>QueueConnection</CODE>
|
||||
object to create one or more <CODE>QueueSession</CODE> objects
|
||||
for producing and consuming messages.
|
||||
|
||||
<P>A <CODE>QueueConnection</CODE> can be used to create a
|
||||
<CODE>QueueSession</CODE>, from which specialized queue-related objects
|
||||
can be created.
|
||||
A more general, and recommended, approach is to use the
|
||||
<CODE>Connection</CODE> object.
|
||||
|
||||
|
||||
<P>The <CODE>QueueConnection</CODE> object
|
||||
should be used to support existing code that has already used it.
|
||||
|
||||
<P>A <CODE>QueueConnection</CODE> cannot be used to create objects
|
||||
specific to the publish/subscribe domain. The
|
||||
<CODE>createDurableConnectionConsumer</CODE> method inherits
|
||||
from <CODE>Connection</CODE>, but must throw an
|
||||
<CODE>IllegalStateException</CODE>
|
||||
if used from <CODE>QueueConnection</CODE>.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Connection.html" title="interface in javax.jms"><CODE>Connection</CODE></A>,
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms"><CODE>ConnectionFactory</CODE></A>,
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><CODE>QueueConnectionFactory</CODE></A></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="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueConnection.html#createConnectionConsumer(javax.jms.Queue, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a connection consumer for this connection (optional operation).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueConnection.html#createQueueSession(boolean, int)">createQueueSession</A></B>(boolean transacted,
|
||||
int acknowledgeMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>QueueSession</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A>, <A HREF="Connection.html#createSession(boolean, int)">createSession</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></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="createConnectionConsumer(javax.jms.Queue, java.lang.String, javax.jms.ServerSessionPool, int)"><!-- --></A><H3>
|
||||
createConnectionConsumer</H3>
|
||||
<PRE>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A> <B>createConnectionConsumer</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a connection consumer for this connection (optional operation).
|
||||
This is an expert facility not used by regular JMS clients.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the queue to access<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>sessionPool</CODE> - the server session pool to associate with this
|
||||
connection consumer<DD><CODE>maxMessages</CODE> - the maximum number of messages that can be
|
||||
assigned to a server session at one time
|
||||
<DT><B>Returns:</B><DD>the connection consumer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>QueueConnection</CODE> object fails
|
||||
to create a connection consumer due to some
|
||||
internal error or invalid arguments for
|
||||
<CODE>sessionPool</CODE> and
|
||||
<CODE>messageSelector</CODE>.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.<DT><B>See Also:</B><DD><A HREF="ConnectionConsumer.html" title="interface in javax.jms"><CODE>ConnectionConsumer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createQueueSession(boolean, int)"><!-- --></A><H3>
|
||||
createQueueSession</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A> <B>createQueueSession</B>(boolean transacted,
|
||||
int acknowledgeMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>QueueSession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>transacted</CODE> - indicates whether the session is transacted<DD><CODE>acknowledgeMode</CODE> - indicates whether the consumer or the
|
||||
client will acknowledge any messages it receives; ignored if the session
|
||||
is transacted. Legal values are <code>Session.AUTO_ACKNOWLEDGE</code>,
|
||||
<code>Session.CLIENT_ACKNOWLEDGE</code>, and
|
||||
<code>Session.DUPS_OK_ACKNOWLEDGE</code>.
|
||||
<DT><B>Returns:</B><DD>a newly created queue session
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>QueueConnection</CODE> object fails
|
||||
to create a session due to some internal error or
|
||||
lack of support for the specific transaction
|
||||
and acknowledgement mode.<DT><B>See Also:</B><DD><A HREF="Session.html#AUTO_ACKNOWLEDGE"><CODE>Session.AUTO_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#CLIENT_ACKNOWLEDGE"><CODE>Session.CLIENT_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#DUPS_OK_ACKNOWLEDGE"><CODE>Session.DUPS_OK_ACKNOWLEDGE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueConnection.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="QueueConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueConnection.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,284 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueConnectionFactory (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueConnectionFactory interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueConnectionFactory (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueConnectionFactory.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="QueueConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueConnectionFactory.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface QueueConnectionFactory</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms">XAQueueConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>QueueConnectionFactory</B><DT>extends <A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>QueueConnectionFactory</CODE> object to create
|
||||
<CODE>QueueConnection</CODE> objects with a point-to-point JMS provider.
|
||||
|
||||
<P><CODE>QueueConnectionFactory</CODE> can be used to create a
|
||||
<CODE>QueueConnection</CODE>, from which specialized queue-related objects
|
||||
can be created. A more general, and recommended, approach
|
||||
is to use the <CODE>ConnectionFactory</CODE> object.
|
||||
|
||||
<P> The <CODE>QueueConnectionFactory</CODE> object
|
||||
can be used to support existing code that already uses it.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="ConnectionFactory.html" title="interface in javax.jms"><CODE>ConnectionFactory</CODE></A></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="QueueConnection.html" title="interface in javax.jms">QueueConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueConnectionFactory.html#createQueueConnection()">createQueueConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a queue connection with the default user identity.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueConnectionFactory.html#createQueueConnection(java.lang.String, java.lang.String)">createQueueConnection</A></B>(java.lang.String userName,
|
||||
java.lang.String password)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a queue connection with the specified user identity.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.ConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="ConnectionFactory.html#createConnection()">createConnection</A>, <A HREF="ConnectionFactory.html#createConnection(java.lang.String, java.lang.String)">createConnection</A></CODE></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="createQueueConnection()"><!-- --></A><H3>
|
||||
createQueueConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A> <B>createQueueConnection</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a queue connection with the default user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
|
||||
.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created queue connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create the queue
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createQueueConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
createQueueConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A> <B>createQueueConnection</B>(java.lang.String userName,
|
||||
java.lang.String password)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a queue connection with the specified user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - the caller's user name<DD><CODE>password</CODE> - the caller's password
|
||||
<DT><B>Returns:</B><DD>a newly created queue connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create the queue
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueConnectionFactory.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="QueueConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueConnectionFactory.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,252 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueReceiver (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueReceiver interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueReceiver (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueReceiver.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueRequestor.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueReceiver.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueReceiver.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="QueueReceiver.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueReceiver.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface QueueReceiver</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>QueueReceiver</B><DT>extends <A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>QueueReceiver</CODE> object to receive messages that
|
||||
have been delivered to a queue.
|
||||
|
||||
<P>Although it is possible to have multiple <CODE>QueueReceiver</CODE>s
|
||||
for the same queue, the JMS API does not define how messages are
|
||||
distributed between the <CODE>QueueReceiver</CODE>s.
|
||||
|
||||
<P>If a <CODE>QueueReceiver</CODE> specifies a message selector, the
|
||||
messages that are not selected remain on the queue. By definition, a message
|
||||
selector allows a <CODE>QueueReceiver</CODE> to skip messages. This
|
||||
means that when the skipped messages are eventually read, the total ordering
|
||||
of the reads does not retain the partial order defined by each message
|
||||
producer. Only <CODE>QueueReceiver</CODE>s without a message selector
|
||||
will read messages in message producer order.
|
||||
|
||||
<P>Creating a <CODE>MessageConsumer</CODE> provides the same features as
|
||||
creating a <CODE>QueueReceiver</CODE>. A <CODE>MessageConsumer</CODE> object is
|
||||
recommended for creating new code. The <CODE>QueueReceiver</CODE> is
|
||||
provided to support existing code.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String)"><CODE>Session.createConsumer(Destination, String)</CODE></A>,
|
||||
<A HREF="Session.html#createConsumer(javax.jms.Destination)"><CODE>Session.createConsumer(Destination)</CODE></A>,
|
||||
<A HREF="QueueSession.html#createReceiver(javax.jms.Queue, java.lang.String)"><CODE>QueueSession.createReceiver(Queue, String)</CODE></A>,
|
||||
<A HREF="QueueSession.html#createReceiver(javax.jms.Queue)"><CODE>QueueSession.createReceiver(Queue)</CODE></A>,
|
||||
<A HREF="MessageConsumer.html" title="interface in javax.jms"><CODE>MessageConsumer</CODE></A></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="Queue.html" title="interface in javax.jms">Queue</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueReceiver.html#getQueue()">getQueue</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the <CODE>Queue</CODE> associated with this queue receiver.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.MessageConsumer"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="MessageConsumer.html#close()">close</A>, <A HREF="MessageConsumer.html#getMessageListener()">getMessageListener</A>, <A HREF="MessageConsumer.html#getMessageSelector()">getMessageSelector</A>, <A HREF="MessageConsumer.html#receive()">receive</A>, <A HREF="MessageConsumer.html#receive(long)">receive</A>, <A HREF="MessageConsumer.html#receiveNoWait()">receiveNoWait</A>, <A HREF="MessageConsumer.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A></CODE></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="getQueue()"><!-- --></A><H3>
|
||||
getQueue</H3>
|
||||
<PRE>
|
||||
<A HREF="Queue.html" title="interface in javax.jms">Queue</A> <B>getQueue</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the <CODE>Queue</CODE> associated with this queue receiver.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this receiver's <CODE>Queue</CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the queue for
|
||||
this queue receiver
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueReceiver.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueRequestor.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueReceiver.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueReceiver.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="QueueReceiver.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueReceiver.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,324 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueRequestor (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueRequestor class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueRequestor (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueRequestor.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueRequestor.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueRequestor.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="QueueRequestor.html#constructor_summary">CONSTR</A> | <A HREF="QueueRequestor.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="QueueRequestor.html#constructor_detail">CONSTR</A> | <A HREF="QueueRequestor.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class QueueRequestor</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.QueueRequestor</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>QueueRequestor</B><DT>extends java.lang.Object</DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The <CODE>QueueRequestor</CODE> helper class simplifies
|
||||
making service requests.
|
||||
|
||||
<P>The <CODE>QueueRequestor</CODE> constructor is given a non-transacted
|
||||
<CODE>QueueSession</CODE> and a destination <CODE>Queue</CODE>. It creates a
|
||||
<CODE>TemporaryQueue</CODE> for the responses and provides a
|
||||
<CODE>request</CODE> method that sends the request message and waits
|
||||
for its reply.
|
||||
|
||||
<P>This is a basic request/reply abstraction that should be sufficient
|
||||
for most uses. JMS providers and clients are free to create more
|
||||
sophisticated versions.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="TopicRequestor.html" title="class in javax.jms"><CODE>TopicRequestor</CODE></A></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="QueueRequestor.html#QueueRequestor(javax.jms.QueueSession, javax.jms.Queue)">QueueRequestor</A></B>(<A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A> session,
|
||||
<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructor for the <CODE>QueueRequestor</CODE> class.</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> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueRequestor.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the <CODE>QueueRequestor</CODE> and its session.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Message.html" title="interface in javax.jms">Message</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueRequestor.html#request(javax.jms.Message)">request</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a request and waits for a reply.</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="QueueRequestor(javax.jms.QueueSession, javax.jms.Queue)"><!-- --></A><H3>
|
||||
QueueRequestor</H3>
|
||||
<PRE>
|
||||
public <B>QueueRequestor</B>(<A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A> session,
|
||||
<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Constructor for the <CODE>QueueRequestor</CODE> class.
|
||||
|
||||
<P>This implementation assumes the session parameter to be non-transacted,
|
||||
with a delivery mode of either <CODE>AUTO_ACKNOWLEDGE</CODE> or
|
||||
<CODE>DUPS_OK_ACKNOWLEDGE</CODE>.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the <CODE>QueueSession</CODE> the queue belongs to<DD><CODE>queue</CODE> - the queue to perform the request/reply call on
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create the
|
||||
<CODE>QueueRequestor</CODE> due to some internal
|
||||
error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
public void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Closes the <CODE>QueueRequestor</CODE> and its session.
|
||||
|
||||
<P>Since a provider may allocate some resources on behalf of a
|
||||
<CODE>QueueRequestor</CODE> outside the Java virtual machine, clients
|
||||
should close them when they
|
||||
are not needed. Relying on garbage collection to eventually reclaim
|
||||
these resources may not be timely enough.
|
||||
|
||||
<P>Note that this method closes the <CODE>QueueSession</CODE> object
|
||||
passed to the <CODE>QueueRequestor</CODE> constructor.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to close the
|
||||
<CODE>QueueRequestor</CODE> due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="request(javax.jms.Message)"><!-- --></A><H3>
|
||||
request</H3>
|
||||
<PRE>
|
||||
public <A HREF="Message.html" title="interface in javax.jms">Message</A> <B>request</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a request and waits for a reply. The temporary queue is used for
|
||||
the <CODE>JMSReplyTo</CODE> destination, and only one reply per request
|
||||
is expected.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send
|
||||
<DT><B>Returns:</B><DD>the reply message
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to complete the
|
||||
request due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueRequestor.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueRequestor.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueRequestor.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="QueueRequestor.html#constructor_summary">CONSTR</A> | <A HREF="QueueRequestor.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="QueueRequestor.html#constructor_detail">CONSTR</A> | <A HREF="QueueRequestor.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,439 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueSender (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueSender interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueSender (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueSender.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueRequestor.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueSender.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueSender.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="QueueSender.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueSender.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface QueueSender</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>QueueSender</B><DT>extends <A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>QueueSender</CODE> object to send messages to a queue.
|
||||
|
||||
<P>Normally, the <CODE>Queue</CODE> is specified when a
|
||||
<CODE>QueueSender</CODE> is created. In this case, an attempt to use
|
||||
the <CODE>send</CODE> methods for an unidentified
|
||||
<CODE>QueueSender</CODE> will throw a
|
||||
<CODE>java.lang.UnsupportedOperationException</CODE>.
|
||||
|
||||
<P>If the <CODE>QueueSender</CODE> is created with an unidentified
|
||||
<CODE>Queue</CODE>, an attempt to use the <CODE>send</CODE> methods that
|
||||
assume that the <CODE>Queue</CODE> has been identified will throw a
|
||||
<CODE>java.lang.UnsupportedOperationException</CODE>.
|
||||
|
||||
<P>During the execution of its <CODE>send</CODE> method, a message
|
||||
must not be changed by other threads within the client.
|
||||
If the message is modified, the result of the <CODE>send</CODE> is
|
||||
undefined.
|
||||
|
||||
<P>After sending a message, a client may retain and modify it
|
||||
without affecting the message that has been sent. The same message
|
||||
object may be sent multiple times.
|
||||
|
||||
<P>The following message headers are set as part of sending a
|
||||
message: <code>JMSDestination</code>, <code>JMSDeliveryMode</code>,
|
||||
<code>JMSExpiration</code>, <code>JMSPriority</code>,
|
||||
<code>JMSMessageID</code> and <code>JMSTimeStamp</code>.
|
||||
When the message is sent, the values of these headers are ignored.
|
||||
After the completion of the <CODE>send</CODE>, the headers hold the values
|
||||
specified by the method sending the message. It is possible for the
|
||||
<code>send</code> method not to set <code>JMSMessageID</code> and
|
||||
<code>JMSTimeStamp</code> if the
|
||||
setting of these headers is explicitly disabled by the
|
||||
<code>MessageProducer.setDisableMessageID</code> or
|
||||
<code>MessageProducer.setDisableMessageTimestamp</code> method.
|
||||
|
||||
<P>Creating a <CODE>MessageProducer</CODE> provides the same features as
|
||||
creating a <CODE>QueueSender</CODE>. A <CODE>MessageProducer</CODE> object is
|
||||
recommended when creating new code. The <CODE>QueueSender</CODE> is
|
||||
provided to support existing code.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="MessageProducer.html" title="interface in javax.jms"><CODE>MessageProducer</CODE></A>,
|
||||
<A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(Destination)</CODE></A>,
|
||||
<A HREF="QueueSession.html#createSender(javax.jms.Queue)"><CODE>QueueSession.createSender(Queue)</CODE></A></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="Queue.html" title="interface in javax.jms">Queue</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSender.html#getQueue()">getQueue</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the queue associated with this <CODE>QueueSender</CODE>.</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="QueueSender.html#send(javax.jms.Message)">send</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to the queue.</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="QueueSender.html#send(javax.jms.Message, int, int, long)">send</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to the queue, specifying delivery mode, priority, and
|
||||
time to live.</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="QueueSender.html#send(javax.jms.Queue, javax.jms.Message)">send</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to a queue for an unidentified message producer.</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="QueueSender.html#send(javax.jms.Queue, javax.jms.Message, int, int, long)">send</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a message to a queue for an unidentified message producer,
|
||||
specifying delivery mode, priority and time to live.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.MessageProducer"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="MessageProducer.html#close()">close</A>, <A HREF="MessageProducer.html#getDeliveryMode()">getDeliveryMode</A>, <A HREF="MessageProducer.html#getDestination()">getDestination</A>, <A HREF="MessageProducer.html#getDisableMessageID()">getDisableMessageID</A>, <A HREF="MessageProducer.html#getDisableMessageTimestamp()">getDisableMessageTimestamp</A>, <A HREF="MessageProducer.html#getPriority()">getPriority</A>, <A HREF="MessageProducer.html#getTimeToLive()">getTimeToLive</A>, <A HREF="MessageProducer.html#send(javax.jms.Destination, javax.jms.Message)">send</A>, <A HREF="MessageProducer.html#send(javax.jms.Destination, javax.jms.Message, int, int, long)">send</A>, <A HREF="MessageProducer.html#setDeliveryMode(int)">setDeliveryMode</A>, <A HREF="MessageProducer.html#setDisableMessageID(boolean)">setDisableMessageID</A>, <A HREF="MessageProducer.html#setDisableMessageTimestamp(boolean)">setDisableMessageTimestamp</A>, <A HREF="MessageProducer.html#setPriority(int)">setPriority</A>, <A HREF="MessageProducer.html#setTimeToLive(long)">setTimeToLive</A></CODE></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="getQueue()"><!-- --></A><H3>
|
||||
getQueue</H3>
|
||||
<PRE>
|
||||
<A HREF="Queue.html" title="interface in javax.jms">Queue</A> <B>getQueue</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the queue associated with this <CODE>QueueSender</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this sender's queue
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the queue for
|
||||
this <CODE>QueueSender</CODE>
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Message)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to the queue. Uses the <CODE>QueueSender</CODE>'s
|
||||
default delivery mode, priority, and time to live.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="MessageProducer.html#send(javax.jms.Message)">send</A></CODE> in interface <CODE><A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with a <CODE>QueueSender</CODE> with
|
||||
an invalid queue.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>QueueSender</CODE> that did
|
||||
not specify a queue at creation time.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getDeliveryMode()"><CODE>MessageProducer.getDeliveryMode()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getTimeToLive()"><CODE>MessageProducer.getTimeToLive()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getPriority()"><CODE>MessageProducer.getPriority()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Message, int, int, long)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to the queue, specifying delivery mode, priority, and
|
||||
time to live.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="MessageProducer.html#send(javax.jms.Message, int, int, long)">send</A></CODE> in interface <CODE><A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send<DD><CODE>deliveryMode</CODE> - the delivery mode to use<DD><CODE>priority</CODE> - the priority for this message<DD><CODE>timeToLive</CODE> - the message's lifetime (in milliseconds)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with a <CODE>QueueSender</CODE> with
|
||||
an invalid queue.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>QueueSender</CODE> that did
|
||||
not specify a queue at creation time.<DT><B>See Also:</B><DD><A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(javax.jms.Destination)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Queue, javax.jms.Message)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to a queue for an unidentified message producer.
|
||||
Uses the <CODE>QueueSender</CODE>'s default delivery mode, priority,
|
||||
and time to live.
|
||||
|
||||
<P>Typically, a message producer is assigned a queue at creation
|
||||
time; however, the JMS API also supports unidentified message producers,
|
||||
which require that the queue be supplied every time a message is
|
||||
sent.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the queue to send this message to<DD><CODE>message</CODE> - the message to send
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with an invalid queue.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getDeliveryMode()"><CODE>MessageProducer.getDeliveryMode()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getTimeToLive()"><CODE>MessageProducer.getTimeToLive()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getPriority()"><CODE>MessageProducer.getPriority()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="send(javax.jms.Queue, javax.jms.Message, int, int, long)"><!-- --></A><H3>
|
||||
send</H3>
|
||||
<PRE>
|
||||
void <B>send</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a message to a queue for an unidentified message producer,
|
||||
specifying delivery mode, priority and time to live.
|
||||
|
||||
<P>Typically, a message producer is assigned a queue at creation
|
||||
time; however, the JMS API also supports unidentified message producers,
|
||||
which require that the queue be supplied every time a message is
|
||||
sent.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the queue to send this message to<DD><CODE>message</CODE> - the message to send<DD><CODE>deliveryMode</CODE> - the delivery mode to use<DD><CODE>priority</CODE> - the priority for this message<DD><CODE>timeToLive</CODE> - the message's lifetime (in milliseconds)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to send the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with an invalid queue.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueSender.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueRequestor.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueSender.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueSender.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="QueueSender.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueSender.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,483 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
QueueSession (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.QueueSession interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="QueueSession (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="QueueSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ResourceAllocationException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueSession.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="QueueSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueSession.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface QueueSession</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD>java.lang.Runnable, <A HREF="Session.html" title="interface in javax.jms">Session</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>QueueSession</B><DT>extends <A HREF="Session.html" title="interface in javax.jms">Session</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>QueueSession</CODE> object provides methods for creating
|
||||
<CODE>QueueReceiver</CODE>, <CODE>QueueSender</CODE>,
|
||||
<CODE>QueueBrowser</CODE>, and <CODE>TemporaryQueue</CODE> objects.
|
||||
|
||||
<P>If there are messages that have been received but not acknowledged
|
||||
when a <CODE>QueueSession</CODE> terminates, these messages will be retained
|
||||
and redelivered when a consumer next accesses the queue.
|
||||
|
||||
<P>A <CODE>QueueSession</CODE> is used for creating Point-to-Point specific
|
||||
objects. In general, use the <CODE>Session</CODE> object.
|
||||
The <CODE>QueueSession</CODE> is used to support
|
||||
existing code. Using the <CODE>Session</CODE> object simplifies the
|
||||
programming model, and allows transactions to be used across the two
|
||||
messaging domains.
|
||||
|
||||
<P>A <CODE>QueueSession</CODE> cannot be used to create objects specific to the
|
||||
publish/subscribe domain. The following methods inherit from
|
||||
<CODE>Session</CODE>, but must throw an
|
||||
<CODE>IllegalStateException</CODE>
|
||||
if they are used from <CODE>QueueSession</CODE>:
|
||||
<UL>
|
||||
<LI><CODE>createDurableSubscriber</CODE>
|
||||
<LI><CODE>createTemporaryTopic</CODE>
|
||||
<LI><CODE>createTopic</CODE>
|
||||
<LI><CODE>unsubscribe</CODE>
|
||||
</UL>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html" title="interface in javax.jms"><CODE>Session</CODE></A>,
|
||||
<A HREF="QueueConnection.html#createQueueSession(boolean, int)"><CODE>QueueConnection.createQueueSession(boolean, int)</CODE></A>,
|
||||
<A HREF="XAQueueSession.html#getQueueSession()"><CODE>XAQueueSession.getQueueSession()</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#AUTO_ACKNOWLEDGE">AUTO_ACKNOWLEDGE</A>, <A HREF="Session.html#CLIENT_ACKNOWLEDGE">CLIENT_ACKNOWLEDGE</A>, <A HREF="Session.html#DUPS_OK_ACKNOWLEDGE">DUPS_OK_ACKNOWLEDGE</A>, <A HREF="Session.html#SESSION_TRANSACTED">SESSION_TRANSACTED</A></CODE></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="QueueBrowser.html" title="interface in javax.jms">QueueBrowser</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createBrowser(javax.jms.Queue)">createBrowser</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>QueueBrowser</CODE> object to peek at the messages on
|
||||
the specified queue.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="QueueBrowser.html" title="interface in javax.jms">QueueBrowser</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createBrowser(javax.jms.Queue, java.lang.String)">createBrowser</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
java.lang.String messageSelector)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>QueueBrowser</CODE> object to peek at the messages on
|
||||
the specified queue using a message selector.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Queue.html" title="interface in javax.jms">Queue</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createQueue(java.lang.String)">createQueue</A></B>(java.lang.String queueName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a queue identity given a <CODE>Queue</CODE> name.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="QueueReceiver.html" title="interface in javax.jms">QueueReceiver</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createReceiver(javax.jms.Queue)">createReceiver</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>QueueReceiver</CODE> object to receive messages from the
|
||||
specified queue.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="QueueReceiver.html" title="interface in javax.jms">QueueReceiver</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createReceiver(javax.jms.Queue, java.lang.String)">createReceiver</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
java.lang.String messageSelector)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>QueueReceiver</CODE> object to receive messages from the
|
||||
specified queue using a message selector.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="QueueSender.html" title="interface in javax.jms">QueueSender</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createSender(javax.jms.Queue)">createSender</A></B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>QueueSender</CODE> object to send messages to the
|
||||
specified queue.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TemporaryQueue.html" title="interface in javax.jms">TemporaryQueue</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="QueueSession.html#createTemporaryQueue()">createTemporaryQueue</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>TemporaryQueue</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#close()">close</A>, <A HREF="Session.html#commit()">commit</A>, <A HREF="Session.html#createBytesMessage()">createBytesMessage</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String, boolean)">createConsumer</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)">createDurableSubscriber</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)">createDurableSubscriber</A>, <A HREF="Session.html#createMapMessage()">createMapMessage</A>, <A HREF="Session.html#createMessage()">createMessage</A>, <A HREF="Session.html#createObjectMessage()">createObjectMessage</A>, <A HREF="Session.html#createObjectMessage(java.io.Serializable)">createObjectMessage</A>, <A HREF="Session.html#createProducer(javax.jms.Destination)">createProducer</A>, <A HREF="Session.html#createStreamMessage()">createStreamMessage</A>, <A HREF="Session.html#createTemporaryTopic()">createTemporaryTopic</A>, <A HREF="Session.html#createTextMessage()">createTextMessage</A>, <A HREF="Session.html#createTextMessage(java.lang.String)">createTextMessage</A>, <A HREF="Session.html#createTopic(java.lang.String)">createTopic</A>, <A HREF="Session.html#getAcknowledgeMode()">getAcknowledgeMode</A>, <A HREF="Session.html#getMessageListener()">getMessageListener</A>, <A HREF="Session.html#getTransacted()">getTransacted</A>, <A HREF="Session.html#recover()">recover</A>, <A HREF="Session.html#rollback()">rollback</A>, <A HREF="Session.html#run()">run</A>, <A HREF="Session.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A>, <A HREF="Session.html#unsubscribe(java.lang.String)">unsubscribe</A></CODE></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="createBrowser(javax.jms.Queue)"><!-- --></A><H3>
|
||||
createBrowser</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms">QueueBrowser</A> <B>createBrowser</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>QueueBrowser</CODE> object to peek at the messages on
|
||||
the specified queue.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createBrowser(javax.jms.Queue)">createBrowser</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the <CODE>Queue</CODE> to access
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a browser
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createBrowser(javax.jms.Queue, java.lang.String)"><!-- --></A><H3>
|
||||
createBrowser</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms">QueueBrowser</A> <B>createBrowser</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
java.lang.String messageSelector)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>QueueBrowser</CODE> object to peek at the messages on
|
||||
the specified queue using a message selector.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createBrowser(javax.jms.Queue, java.lang.String)">createBrowser</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the <CODE>Queue</CODE> to access<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a browser
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createQueue(java.lang.String)"><!-- --></A><H3>
|
||||
createQueue</H3>
|
||||
<PRE>
|
||||
<A HREF="Queue.html" title="interface in javax.jms">Queue</A> <B>createQueue</B>(java.lang.String queueName)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a queue identity given a <CODE>Queue</CODE> name.
|
||||
|
||||
<P>This facility is provided for the rare cases where clients need to
|
||||
dynamically manipulate queue identity. It allows the creation of a
|
||||
queue identity with a provider-specific name. Clients that depend
|
||||
on this ability are not portable.
|
||||
|
||||
<P>Note that this method is not for creating the physical queue.
|
||||
The physical creation of queues is an administrative task and is not
|
||||
to be initiated by the JMS API. The one exception is the
|
||||
creation of temporary queues, which is accomplished with the
|
||||
<CODE>createTemporaryQueue</CODE> method.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createQueue(java.lang.String)">createQueue</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queueName</CODE> - the name of this <CODE>Queue</CODE>
|
||||
<DT><B>Returns:</B><DD>a <CODE>Queue</CODE> with the given name
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a queue
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createReceiver(javax.jms.Queue)"><!-- --></A><H3>
|
||||
createReceiver</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms">QueueReceiver</A> <B>createReceiver</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>QueueReceiver</CODE> object to receive messages from the
|
||||
specified queue.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the <CODE>Queue</CODE> to access
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a receiver
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createReceiver(javax.jms.Queue, java.lang.String)"><!-- --></A><H3>
|
||||
createReceiver</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms">QueueReceiver</A> <B>createReceiver</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue,
|
||||
java.lang.String messageSelector)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>QueueReceiver</CODE> object to receive messages from the
|
||||
specified queue using a message selector.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the <CODE>Queue</CODE> to access<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a receiver
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createSender(javax.jms.Queue)"><!-- --></A><H3>
|
||||
createSender</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms">QueueSender</A> <B>createSender</B>(<A HREF="Queue.html" title="interface in javax.jms">Queue</A> queue)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>QueueSender</CODE> object to send messages to the
|
||||
specified queue.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>queue</CODE> - the <CODE>Queue</CODE> to access, or null if this is an
|
||||
unidentified producer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a sender
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid queue is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createTemporaryQueue()"><!-- --></A><H3>
|
||||
createTemporaryQueue</H3>
|
||||
<PRE>
|
||||
<A HREF="TemporaryQueue.html" title="interface in javax.jms">TemporaryQueue</A> <B>createTemporaryQueue</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>TemporaryQueue</CODE> object. Its lifetime will be that
|
||||
of the <CODE>QueueConnection</CODE> unless it is deleted earlier.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createTemporaryQueue()">createTemporaryQueue</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a temporary queue identity
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a temporary queue
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="QueueSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ResourceAllocationException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FQueueSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="QueueSession.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="QueueSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="QueueSession.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,282 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
ResourceAllocationException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ResourceAllocationException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ResourceAllocationException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ResourceAllocationException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ServerSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FResourceAllocationException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ResourceAllocationException.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="ResourceAllocationException.html#constructor_summary">CONSTR</A> | <A HREF="ResourceAllocationException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="ResourceAllocationException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class ResourceAllocationException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.ResourceAllocationException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>ResourceAllocationException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P>This exception is thrown when a provider is unable to allocate the
|
||||
resources required by a method. For example, this exception should be
|
||||
thrown when a call to
|
||||
<CODE>TopicConnectionFactory.createTopicConnection</CODE> fails due to a
|
||||
lack of JMS provider resources.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.ResourceAllocationException">Serialized Form</A></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="ResourceAllocationException.html#ResourceAllocationException(java.lang.String)">ResourceAllocationException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>ResourceAllocationException</CODE> with the specified
|
||||
reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="ResourceAllocationException.html#ResourceAllocationException(java.lang.String, java.lang.String)">ResourceAllocationException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>ResourceAllocationException</CODE> with the specified
|
||||
reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="ResourceAllocationException(java.lang.String)"><!-- --></A><H3>
|
||||
ResourceAllocationException</H3>
|
||||
<PRE>
|
||||
public <B>ResourceAllocationException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>ResourceAllocationException</CODE> with the specified
|
||||
reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="ResourceAllocationException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
ResourceAllocationException</H3>
|
||||
<PRE>
|
||||
public <B>ResourceAllocationException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>ResourceAllocationException</CODE> with the specified
|
||||
reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ResourceAllocationException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ServerSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FResourceAllocationException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ResourceAllocationException.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="ResourceAllocationException.html#constructor_summary">CONSTR</A> | <A HREF="ResourceAllocationException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="ResourceAllocationException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,284 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
ServerSession (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ServerSession interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ServerSession (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ServerSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ResourceAllocationException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FServerSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ServerSession.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="ServerSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ServerSession.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ServerSession</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ServerSession</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>ServerSession</CODE> object is an application server object that
|
||||
is used by a server to associate a thread with a JMS session (optional).
|
||||
|
||||
<P>A <CODE>ServerSession</CODE> implements two methods:
|
||||
|
||||
<UL>
|
||||
<LI><CODE>getSession</CODE> - returns the <CODE>ServerSession</CODE>'s
|
||||
JMS session.
|
||||
<LI><CODE>start</CODE> - starts the execution of the
|
||||
<CODE>ServerSession</CODE>
|
||||
thread and results in the execution of the JMS session's
|
||||
<CODE>run</CODE> method.
|
||||
</UL>
|
||||
|
||||
<P>A <CODE>ConnectionConsumer</CODE> implemented by a JMS provider uses a
|
||||
<CODE>ServerSession</CODE> to process one or more messages that have
|
||||
arrived. It does this by getting a <CODE>ServerSession</CODE> from the
|
||||
<CODE>ConnectionConsumer</CODE>'s <CODE>ServerSessionPool</CODE>; getting
|
||||
the <CODE>ServerSession</CODE>'s JMS session; loading it with the messages;
|
||||
and then starting the <CODE>ServerSession</CODE>.
|
||||
|
||||
<P>In most cases the <CODE>ServerSession</CODE> will register some object
|
||||
it provides as the <CODE>ServerSession</CODE>'s thread run object. The
|
||||
<CODE>ServerSession</CODE>'s <CODE>start</CODE> method will call the
|
||||
thread's <CODE>start</CODE> method, which will start the new thread, and
|
||||
from it, call the <CODE>run</CODE> method of the
|
||||
<CODE>ServerSession</CODE>'s run object. This object will do some
|
||||
housekeeping and then call the <CODE>Session</CODE>'s <CODE>run</CODE>
|
||||
method. When <CODE>run</CODE> returns, the <CODE>ServerSession</CODE>'s run
|
||||
object can return the <CODE>ServerSession</CODE> to the
|
||||
<CODE>ServerSessionPool</CODE>, and the cycle starts again.
|
||||
|
||||
<P>Note that the JMS API does not architect how the
|
||||
<CODE>ConnectionConsumer</CODE> loads the <CODE>Session</CODE> with
|
||||
messages. Since both the <CODE>ConnectionConsumer</CODE> and
|
||||
<CODE>Session</CODE> are implemented by the same JMS provider, they can
|
||||
accomplish the load using a private mechanism.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="ServerSessionPool.html" title="interface in javax.jms"><CODE>ServerSessionPool</CODE></A>,
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms"><CODE>ConnectionConsumer</CODE></A></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="Session.html" title="interface in javax.jms">Session</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ServerSession.html#getSession()">getSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Return the <CODE>ServerSession</CODE>'s <CODE>Session</CODE>.</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="ServerSession.html#start()">start</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Cause the <CODE>Session</CODE>'s <CODE>run</CODE> method to be called
|
||||
to process messages that were just assigned to it.</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="getSession()"><!-- --></A><H3>
|
||||
getSession</H3>
|
||||
<PRE>
|
||||
<A HREF="Session.html" title="interface in javax.jms">Session</A> <B>getSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Return the <CODE>ServerSession</CODE>'s <CODE>Session</CODE>. This must
|
||||
be a <CODE>Session</CODE> created by the same <CODE>Connection</CODE>
|
||||
that will be dispatching messages to it. The provider will assign one or
|
||||
more messages to the <CODE>Session</CODE>
|
||||
and then call <CODE>start</CODE> on the <CODE>ServerSession</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the server session's session
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the associated
|
||||
session for this <CODE>ServerSession</CODE> due
|
||||
to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="start()"><!-- --></A><H3>
|
||||
start</H3>
|
||||
<PRE>
|
||||
void <B>start</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Cause the <CODE>Session</CODE>'s <CODE>run</CODE> method to be called
|
||||
to process messages that were just assigned to it.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to start the server
|
||||
session to process messages due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ServerSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ResourceAllocationException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FServerSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ServerSession.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="ServerSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ServerSession.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,229 @@
|
||||
<!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_19) on Fri Aug 12 11:25:14 EDT 2011 -->
|
||||
<TITLE>
|
||||
ServerSessionPool (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.ServerSessionPool interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ServerSessionPool (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="ServerSessionPool.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ServerSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Session.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FServerSessionPool.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ServerSessionPool.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="ServerSessionPool.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ServerSessionPool.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface ServerSessionPool</H2>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ServerSessionPool</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>ServerSessionPool</CODE> object is an object implemented by an
|
||||
application server to provide a pool of <CODE>ServerSession</CODE> objects
|
||||
for processing the messages of a <CODE>ConnectionConsumer</CODE> (optional).
|
||||
|
||||
<P>Its only method is <CODE>getServerSession</CODE>. The JMS API does not
|
||||
architect how the pool is implemented. It could be a static pool of
|
||||
<CODE>ServerSession</CODE> objects, or it could use a sophisticated
|
||||
algorithm to dynamically create <CODE>ServerSession</CODE> objects as
|
||||
needed.
|
||||
|
||||
<P>If the <CODE>ServerSessionPool</CODE> is out of
|
||||
<CODE>ServerSession</CODE> objects, the <CODE>getServerSession</CODE> call
|
||||
may block. If a <CODE>ConnectionConsumer</CODE> is blocked, it cannot
|
||||
deliver new messages until a <CODE>ServerSession</CODE> is
|
||||
eventually returned.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="ServerSession.html" title="interface in javax.jms"><CODE>ServerSession</CODE></A></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="ServerSession.html" title="interface in javax.jms">ServerSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="ServerSessionPool.html#getServerSession()">getServerSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Return a server session from the pool.</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="getServerSession()"><!-- --></A><H3>
|
||||
getServerSession</H3>
|
||||
<PRE>
|
||||
<A HREF="ServerSession.html" title="interface in javax.jms">ServerSession</A> <B>getServerSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Return a server session from the pool.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a server session from the pool
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if an application server fails to
|
||||
return a <CODE>ServerSession</CODE> out of its
|
||||
server session pool.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="ServerSessionPool.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="ServerSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Session.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FServerSessionPool.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ServerSessionPool.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="ServerSessionPool.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="ServerSessionPool.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,240 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TemporaryQueue (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TemporaryQueue interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TemporaryQueue (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TemporaryQueue.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="StreamMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TemporaryTopic.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTemporaryQueue.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TemporaryQueue.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="TemporaryQueue.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TemporaryQueue.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TemporaryQueue</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Destination.html" title="interface in javax.jms">Destination</A>, <A HREF="Queue.html" title="interface in javax.jms">Queue</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TemporaryQueue</B><DT>extends <A HREF="Queue.html" title="interface in javax.jms">Queue</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>TemporaryQueue</CODE> object is a unique <CODE>Queue</CODE> object
|
||||
created for the duration of a <CODE>Connection</CODE>. It is a
|
||||
system-defined queue that can be consumed only by the
|
||||
<CODE>Connection</CODE> that created it.
|
||||
|
||||
<P>A <CODE>TemporaryQueue</CODE> object can be created at either the
|
||||
<CODE>Session</CODE> or <CODE>QueueSession</CODE> level. Creating it at the
|
||||
<CODE>Session</CODE> level allows to the <CODE>TemporaryQueue</CODE> to
|
||||
participate in transactions with objects from the Pub/Sub domain.
|
||||
If it is created at the <CODE>QueueSession</CODE>, it will only
|
||||
be able participate in transactions with objects from the PTP domain.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createTemporaryQueue()"><CODE>Session.createTemporaryQueue()</CODE></A>,
|
||||
<A HREF="QueueSession.html#createTemporaryQueue()"><CODE>QueueSession.createTemporaryQueue()</CODE></A></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="TemporaryQueue.html#delete()">delete</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Deletes this temporary queue.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Queue"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Queue.html" title="interface in javax.jms">Queue</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Queue.html#getQueueName()">getQueueName</A>, <A HREF="Queue.html#toString()">toString</A></CODE></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="delete()"><!-- --></A><H3>
|
||||
delete</H3>
|
||||
<PRE>
|
||||
void <B>delete</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Deletes this temporary queue. If there are existing receivers
|
||||
still using it, a <CODE>JMSException</CODE> will be thrown.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to delete the
|
||||
temporary queue due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TemporaryQueue.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="StreamMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TemporaryTopic.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTemporaryQueue.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TemporaryQueue.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="TemporaryQueue.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TemporaryQueue.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,241 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TemporaryTopic (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TemporaryTopic interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TemporaryTopic (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TemporaryTopic.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TemporaryQueue.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TextMessage.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTemporaryTopic.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TemporaryTopic.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="TemporaryTopic.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TemporaryTopic.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TemporaryTopic</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Destination.html" title="interface in javax.jms">Destination</A>, <A HREF="Topic.html" title="interface in javax.jms">Topic</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TemporaryTopic</B><DT>extends <A HREF="Topic.html" title="interface in javax.jms">Topic</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>TemporaryTopic</CODE> object is a unique <CODE>Topic</CODE> object
|
||||
created for the duration of a <CODE>Connection</CODE>. It is a
|
||||
system-defined topic that can be consumed only by the
|
||||
<CODE>Connection</CODE> that created it.
|
||||
|
||||
<P>A <CODE>TemporaryTopic</CODE> object can be created either at the
|
||||
<CODE>Session</CODE> or <CODE>TopicSession</CODE> level. Creating it at the
|
||||
<CODE>Session</CODE> level allows the <CODE>TemporaryTopic</CODE> to participate
|
||||
in the same transaction with objects from the PTP domain.
|
||||
If a <CODE>TemporaryTopic</CODE> is created at the
|
||||
<CODE>TopicSession</CODE>, it will only
|
||||
be able participate in transactions with objects from the Pub/Sub domain.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createTemporaryTopic()"><CODE>Session.createTemporaryTopic()</CODE></A>,
|
||||
<A HREF="TopicSession.html#createTemporaryTopic()"><CODE>TopicSession.createTemporaryTopic()</CODE></A></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="TemporaryTopic.html#delete()">delete</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Deletes this temporary topic.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Topic"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Topic.html" title="interface in javax.jms">Topic</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Topic.html#getTopicName()">getTopicName</A>, <A HREF="Topic.html#toString()">toString</A></CODE></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="delete()"><!-- --></A><H3>
|
||||
delete</H3>
|
||||
<PRE>
|
||||
void <B>delete</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Deletes this temporary topic. If there are existing subscribers
|
||||
still using it, a <CODE>JMSException</CODE> will be thrown.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to delete the
|
||||
temporary topic due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TemporaryTopic.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TemporaryQueue.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TextMessage.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTemporaryTopic.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TemporaryTopic.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="TemporaryTopic.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TemporaryTopic.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,297 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TextMessage (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TextMessage interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TextMessage (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TextMessage.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TemporaryTopic.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Topic.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTextMessage.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TextMessage.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="TextMessage.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TextMessage.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TextMessage</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Message.html" title="interface in javax.jms">Message</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TextMessage</B><DT>extends <A HREF="Message.html" title="interface in javax.jms">Message</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>TextMessage</CODE> object is used to send a message containing a
|
||||
<CODE>java.lang.String</CODE>.
|
||||
It inherits from the <CODE>Message</CODE> interface and adds a text message
|
||||
body.
|
||||
|
||||
<P>This message type can be used to transport text-based messages, including
|
||||
those with XML content.
|
||||
|
||||
<P>When a client receives a <CODE>TextMessage</CODE>, it is in read-only
|
||||
mode. If a client attempts to write to the message at this point, a
|
||||
<CODE>MessageNotWriteableException</CODE> is thrown. If
|
||||
<CODE>clearBody</CODE> is
|
||||
called, the message can now be both read from and written to.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createTextMessage()"><CODE>Session.createTextMessage()</CODE></A>,
|
||||
<A HREF="Session.html#createTextMessage(java.lang.String)"><CODE>Session.createTextMessage(String)</CODE></A>,
|
||||
<A HREF="BytesMessage.html" title="interface in javax.jms"><CODE>BytesMessage</CODE></A>,
|
||||
<A HREF="MapMessage.html" title="interface in javax.jms"><CODE>MapMessage</CODE></A>,
|
||||
<A HREF="Message.html" title="interface in javax.jms"><CODE>Message</CODE></A>,
|
||||
<A HREF="ObjectMessage.html" title="interface in javax.jms"><CODE>ObjectMessage</CODE></A>,
|
||||
<A HREF="StreamMessage.html" title="interface in javax.jms"><CODE>StreamMessage</CODE></A>,
|
||||
<CODE>String</CODE></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Message"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Message.html" title="interface in javax.jms">Message</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Message.html#DEFAULT_DELIVERY_MODE">DEFAULT_DELIVERY_MODE</A>, <A HREF="Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</A>, <A HREF="Message.html#DEFAULT_TIME_TO_LIVE">DEFAULT_TIME_TO_LIVE</A></CODE></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> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TextMessage.html#getText()">getText</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the string containing this message's data.</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="TextMessage.html#setText(java.lang.String)">setText</A></B>(java.lang.String string)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the string containing this message's data.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Message"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Message.html" title="interface in javax.jms">Message</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Message.html#acknowledge()">acknowledge</A>, <A HREF="Message.html#clearBody()">clearBody</A>, <A HREF="Message.html#clearProperties()">clearProperties</A>, <A HREF="Message.html#getBooleanProperty(java.lang.String)">getBooleanProperty</A>, <A HREF="Message.html#getByteProperty(java.lang.String)">getByteProperty</A>, <A HREF="Message.html#getDoubleProperty(java.lang.String)">getDoubleProperty</A>, <A HREF="Message.html#getFloatProperty(java.lang.String)">getFloatProperty</A>, <A HREF="Message.html#getIntProperty(java.lang.String)">getIntProperty</A>, <A HREF="Message.html#getJMSCorrelationID()">getJMSCorrelationID</A>, <A HREF="Message.html#getJMSCorrelationIDAsBytes()">getJMSCorrelationIDAsBytes</A>, <A HREF="Message.html#getJMSDeliveryMode()">getJMSDeliveryMode</A>, <A HREF="Message.html#getJMSDestination()">getJMSDestination</A>, <A HREF="Message.html#getJMSExpiration()">getJMSExpiration</A>, <A HREF="Message.html#getJMSMessageID()">getJMSMessageID</A>, <A HREF="Message.html#getJMSPriority()">getJMSPriority</A>, <A HREF="Message.html#getJMSRedelivered()">getJMSRedelivered</A>, <A HREF="Message.html#getJMSReplyTo()">getJMSReplyTo</A>, <A HREF="Message.html#getJMSTimestamp()">getJMSTimestamp</A>, <A HREF="Message.html#getJMSType()">getJMSType</A>, <A HREF="Message.html#getLongProperty(java.lang.String)">getLongProperty</A>, <A HREF="Message.html#getObjectProperty(java.lang.String)">getObjectProperty</A>, <A HREF="Message.html#getPropertyNames()">getPropertyNames</A>, <A HREF="Message.html#getShortProperty(java.lang.String)">getShortProperty</A>, <A HREF="Message.html#getStringProperty(java.lang.String)">getStringProperty</A>, <A HREF="Message.html#propertyExists(java.lang.String)">propertyExists</A>, <A HREF="Message.html#setBooleanProperty(java.lang.String, boolean)">setBooleanProperty</A>, <A HREF="Message.html#setByteProperty(java.lang.String, byte)">setByteProperty</A>, <A HREF="Message.html#setDoubleProperty(java.lang.String, double)">setDoubleProperty</A>, <A HREF="Message.html#setFloatProperty(java.lang.String, float)">setFloatProperty</A>, <A HREF="Message.html#setIntProperty(java.lang.String, int)">setIntProperty</A>, <A HREF="Message.html#setJMSCorrelationID(java.lang.String)">setJMSCorrelationID</A>, <A HREF="Message.html#setJMSCorrelationIDAsBytes(byte[])">setJMSCorrelationIDAsBytes</A>, <A HREF="Message.html#setJMSDeliveryMode(int)">setJMSDeliveryMode</A>, <A HREF="Message.html#setJMSDestination(javax.jms.Destination)">setJMSDestination</A>, <A HREF="Message.html#setJMSExpiration(long)">setJMSExpiration</A>, <A HREF="Message.html#setJMSMessageID(java.lang.String)">setJMSMessageID</A>, <A HREF="Message.html#setJMSPriority(int)">setJMSPriority</A>, <A HREF="Message.html#setJMSRedelivered(boolean)">setJMSRedelivered</A>, <A HREF="Message.html#setJMSReplyTo(javax.jms.Destination)">setJMSReplyTo</A>, <A HREF="Message.html#setJMSTimestamp(long)">setJMSTimestamp</A>, <A HREF="Message.html#setJMSType(java.lang.String)">setJMSType</A>, <A HREF="Message.html#setLongProperty(java.lang.String, long)">setLongProperty</A>, <A HREF="Message.html#setObjectProperty(java.lang.String, java.lang.Object)">setObjectProperty</A>, <A HREF="Message.html#setShortProperty(java.lang.String, short)">setShortProperty</A>, <A HREF="Message.html#setStringProperty(java.lang.String, java.lang.String)">setStringProperty</A></CODE></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="getText()"><!-- --></A><H3>
|
||||
getText</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getText</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the string containing this message's data. The default
|
||||
value is null.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the <CODE>String</CODE> containing the message's data
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the text due to
|
||||
some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setText(java.lang.String)"><!-- --></A><H3>
|
||||
setText</H3>
|
||||
<PRE>
|
||||
void <B>setText</B>(java.lang.String string)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sets the string containing this message's data.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>string</CODE> - the <CODE>String</CODE> containing the message's data
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to set the text due to
|
||||
some internal error.
|
||||
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
||||
mode.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TextMessage.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TemporaryTopic.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="Topic.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTextMessage.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TextMessage.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="TextMessage.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TextMessage.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
Topic (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.Topic interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="Topic (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="Topic.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TextMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopic.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Topic.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="Topic.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="Topic.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface Topic</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Destination.html" title="interface in javax.jms">Destination</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="TemporaryTopic.html" title="interface in javax.jms">TemporaryTopic</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>Topic</B><DT>extends <A HREF="Destination.html" title="interface in javax.jms">Destination</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>Topic</CODE> object encapsulates a provider-specific topic name.
|
||||
It is the way a client specifies the identity of a topic to JMS API methods.
|
||||
For those methods that use a <CODE>Destination</CODE> as a parameter, a
|
||||
<CODE>Topic</CODE> object may used as an argument . For
|
||||
example, a Topic can be used to create a <CODE>MessageConsumer</CODE>
|
||||
and a <CODE>MessageProducer</CODE>
|
||||
by calling:
|
||||
<UL>
|
||||
<LI> <CODE>Session.CreateConsumer(Destination destination)</CODE>
|
||||
<LI> <CODE>Session.CreateProducer(Destination destination)</CODE>
|
||||
|
||||
</UL>
|
||||
|
||||
<P>Many publish/subscribe (pub/sub) providers group topics into hierarchies
|
||||
and provide various options for subscribing to parts of the hierarchy. The
|
||||
JMS API places no restriction on what a <CODE>Topic</CODE> object
|
||||
represents. It may be a leaf in a topic hierarchy, or it may be a larger
|
||||
part of the hierarchy.
|
||||
|
||||
<P>The organization of topics and the granularity of subscriptions to
|
||||
them is an important part of a pub/sub application's architecture. The JMS
|
||||
API
|
||||
does not specify a policy for how this should be done. If an application
|
||||
takes advantage of a provider-specific topic-grouping mechanism, it
|
||||
should document this. If the application is installed using a different
|
||||
provider, it is the job of the administrator to construct an equivalent
|
||||
topic architecture and create equivalent <CODE>Topic</CODE> objects.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createConsumer(javax.jms.Destination)"><CODE>Session.createConsumer(Destination)</CODE></A>,
|
||||
<A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(Destination)</CODE></A>,
|
||||
<A HREF="TopicSession.html#createTopic(java.lang.String)"><CODE>TopicSession.createTopic(String)</CODE></A></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> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Topic.html#getTopicName()">getTopicName</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the name of this topic.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="Topic.html#toString()">toString</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of this object.</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="getTopicName()"><!-- --></A><H3>
|
||||
getTopicName</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getTopicName</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the name of this topic.
|
||||
|
||||
<P>Clients that depend upon the name are not portable.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the topic name
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider implementation of
|
||||
<CODE>Topic</CODE> fails to return the topic
|
||||
name due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="toString()"><!-- --></A><H3>
|
||||
toString</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>toString</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of this object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the provider-specific identity values for this topic</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="Topic.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TextMessage.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopic.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Topic.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="Topic.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="Topic.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,351 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TopicConnection (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TopicConnection interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TopicConnection (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TopicConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Topic.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicConnection.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="TopicConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicConnection.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TopicConnection</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Connection.html" title="interface in javax.jms">Connection</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TopicConnection</B><DT>extends <A HREF="Connection.html" title="interface in javax.jms">Connection</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>TopicConnection</CODE> object is an active connection to a
|
||||
publish/subscribe JMS provider. A client uses a <CODE>TopicConnection</CODE>
|
||||
object to create one or more <CODE>TopicSession</CODE> objects
|
||||
for producing and consuming messages.
|
||||
|
||||
<P>A <CODE>TopicConnection</CODE> can be used to create a
|
||||
<CODE>TopicSession</CODE>, from which
|
||||
specialized topic-related objects can be created.
|
||||
A more general, and recommended approach is to use the
|
||||
<CODE>Connection</CODE> object.
|
||||
|
||||
|
||||
<P>The <CODE>TopicConnection</CODE> object
|
||||
should be used to support existing code.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Connection.html" title="interface in javax.jms"><CODE>Connection</CODE></A>,
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms"><CODE>ConnectionFactory</CODE></A>,
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><CODE>TopicConnectionFactory</CODE></A></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="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicConnection.html#createConnectionConsumer(javax.jms.Topic, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a connection consumer for this connection (optional operation).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicConnection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String subscriptionName,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)</CODE>
|
||||
|
||||
<BR>
|
||||
Create a durable connection consumer for this connection (optional operation).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicConnection.html#createTopicSession(boolean, int)">createTopicSession</A></B>(boolean transacted,
|
||||
int acknowledgeMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>TopicSession</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#createSession(boolean, int)">createSession</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></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="createConnectionConsumer(javax.jms.Topic, java.lang.String, javax.jms.ServerSessionPool, int)"><!-- --></A><H3>
|
||||
createConnectionConsumer</H3>
|
||||
<PRE>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A> <B>createConnectionConsumer</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a connection consumer for this connection (optional operation).
|
||||
This is an expert facility not used by regular JMS clients.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the topic to access<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>sessionPool</CODE> - the server session pool to associate with this
|
||||
connection consumer<DD><CODE>maxMessages</CODE> - the maximum number of messages that can be
|
||||
assigned to a server session at one time
|
||||
<DT><B>Returns:</B><DD>the connection consumer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>TopicConnection</CODE> object fails
|
||||
to create a connection consumer due to some
|
||||
internal error or invalid arguments for
|
||||
<CODE>sessionPool</CODE> and
|
||||
<CODE>messageSelector</CODE>.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.<DT><B>See Also:</B><DD><A HREF="ConnectionConsumer.html" title="interface in javax.jms"><CODE>ConnectionConsumer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)"><!-- --></A><H3>
|
||||
createDurableConnectionConsumer</H3>
|
||||
<PRE>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A> <B>createDurableConnectionConsumer</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String subscriptionName,
|
||||
java.lang.String messageSelector,
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A> sessionPool,
|
||||
int maxMessages)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Create a durable connection consumer for this connection (optional operation).
|
||||
This is an expert facility not used by regular JMS clients.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A></CODE> in interface <CODE><A HREF="Connection.html" title="interface in javax.jms">Connection</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the topic to access<DD><CODE>subscriptionName</CODE> - durable subscription name<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>sessionPool</CODE> - the server session pool to associate with this
|
||||
durable connection consumer<DD><CODE>maxMessages</CODE> - the maximum number of messages that can be
|
||||
assigned to a server session at one time
|
||||
<DT><B>Returns:</B><DD>the durable connection consumer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>TopicConnection</CODE> object fails
|
||||
to create a connection consumer due to some
|
||||
internal error or invalid arguments for
|
||||
<CODE>sessionPool</CODE> and
|
||||
<CODE>messageSelector</CODE>.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.<DT><B>See Also:</B><DD><A HREF="ConnectionConsumer.html" title="interface in javax.jms"><CODE>ConnectionConsumer</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createTopicSession(boolean, int)"><!-- --></A><H3>
|
||||
createTopicSession</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A> <B>createTopicSession</B>(boolean transacted,
|
||||
int acknowledgeMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>TopicSession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>transacted</CODE> - indicates whether the session is transacted<DD><CODE>acknowledgeMode</CODE> - indicates whether the consumer or the
|
||||
client will acknowledge any messages it receives; ignored if the session
|
||||
is transacted. Legal values are <code>Session.AUTO_ACKNOWLEDGE</code>,
|
||||
<code>Session.CLIENT_ACKNOWLEDGE</code>, and
|
||||
<code>Session.DUPS_OK_ACKNOWLEDGE</code>.
|
||||
<DT><B>Returns:</B><DD>a newly created topic session
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>TopicConnection</CODE> object fails
|
||||
to create a session due to some internal error or
|
||||
lack of support for the specific transaction
|
||||
and acknowledgement mode.<DT><B>See Also:</B><DD><A HREF="Session.html#AUTO_ACKNOWLEDGE"><CODE>Session.AUTO_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#CLIENT_ACKNOWLEDGE"><CODE>Session.CLIENT_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#DUPS_OK_ACKNOWLEDGE"><CODE>Session.DUPS_OK_ACKNOWLEDGE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TopicConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="Topic.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicConnection.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="TopicConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicConnection.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,282 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TopicConnectionFactory (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TopicConnectionFactory interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TopicConnectionFactory (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TopicConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicPublisher.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicConnectionFactory.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="TopicConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicConnectionFactory.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TopicConnectionFactory</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XATopicConnectionFactory.html" title="interface in javax.jms">XATopicConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TopicConnectionFactory</B><DT>extends <A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>TopicConnectionFactory</CODE> object to create
|
||||
<CODE>TopicConnection</CODE> objects with a publish/subscribe JMS provider.
|
||||
|
||||
<P>A<CODE> TopicConnectionFactory</CODE> can be used to create a
|
||||
<CODE>TopicConnection</CODE>, from which specialized topic-related objects
|
||||
can be created. A more general, and recommended approach
|
||||
is to use the <CODE>ConnectionFactory</CODE> object.
|
||||
|
||||
<P> The <CODE>TopicConnectionFactory</CODE> object
|
||||
should be used to support existing code.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="ConnectionFactory.html" title="interface in javax.jms"><CODE>ConnectionFactory</CODE></A></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="TopicConnection.html" title="interface in javax.jms">TopicConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicConnectionFactory.html#createTopicConnection()">createTopicConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a topic connection with the default user identity.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicConnectionFactory.html#createTopicConnection(java.lang.String, java.lang.String)">createTopicConnection</A></B>(java.lang.String userName,
|
||||
java.lang.String password)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a topic connection with the specified user identity.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.ConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="ConnectionFactory.html#createConnection()">createConnection</A>, <A HREF="ConnectionFactory.html#createConnection(java.lang.String, java.lang.String)">createConnection</A></CODE></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="createTopicConnection()"><!-- --></A><H3>
|
||||
createTopicConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A> <B>createTopicConnection</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a topic connection with the default user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created topic connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create a topic
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createTopicConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
createTopicConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A> <B>createTopicConnection</B>(java.lang.String userName,
|
||||
java.lang.String password)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a topic connection with the specified user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - the caller's user name<DD><CODE>password</CODE> - the caller's password
|
||||
<DT><B>Returns:</B><DD>a newly created topic connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create a topic
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TopicConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicPublisher.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicConnectionFactory.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="TopicConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicConnectionFactory.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,449 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TopicPublisher (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TopicPublisher interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TopicPublisher (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TopicPublisher.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicRequestor.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicPublisher.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicPublisher.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="TopicPublisher.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicPublisher.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TopicPublisher</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TopicPublisher</B><DT>extends <A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>TopicPublisher</CODE> object to publish messages on a
|
||||
topic. A <CODE>TopicPublisher</CODE> object is the publish-subscribe form
|
||||
of a message producer.
|
||||
|
||||
<P>Normally, the <CODE>Topic</CODE> is specified when a
|
||||
<CODE>TopicPublisher</CODE> is created. In this case, an attempt to use
|
||||
the <CODE>publish</CODE> methods for an unidentified
|
||||
<CODE>TopicPublisher</CODE> will throw a
|
||||
<CODE>java.lang.UnsupportedOperationException</CODE>.
|
||||
|
||||
<P>If the <CODE>TopicPublisher</CODE> is created with an unidentified
|
||||
<CODE>Topic</CODE>, an attempt to use the <CODE>publish</CODE> methods that
|
||||
assume that the <CODE>Topic</CODE> has been identified will throw a
|
||||
<CODE>java.lang.UnsupportedOperationException</CODE>.
|
||||
|
||||
<P>During the execution of its <CODE>publish</CODE> method,
|
||||
a message must not be changed by other threads within the client.
|
||||
If the message is modified, the result of the <CODE>publish</CODE> is
|
||||
undefined.
|
||||
|
||||
<P>After publishing a message, a client may retain and modify it
|
||||
without affecting the message that has been published. The same message
|
||||
object may be published multiple times.
|
||||
|
||||
<P>The following message headers are set as part of publishing a
|
||||
message: <code>JMSDestination</code>, <code>JMSDeliveryMode</code>,
|
||||
<code>JMSExpiration</code>, <code>JMSPriority</code>,
|
||||
<code>JMSMessageID</code> and <code>JMSTimeStamp</code>.
|
||||
When the message is published, the values of these headers are ignored.
|
||||
After completion of the <CODE>publish</CODE>, the headers hold the values
|
||||
specified by the method publishing the message. It is possible for the
|
||||
<CODE>publish</CODE> method not to set <code>JMSMessageID</code> and
|
||||
<code>JMSTimeStamp</code> if the
|
||||
setting of these headers is explicitly disabled by the
|
||||
<code>MessageProducer.setDisableMessageID</code> or
|
||||
<code>MessageProducer.setDisableMessageTimestamp</code> method.
|
||||
|
||||
<P>Creating a <CODE>MessageProducer</CODE> provides the same features as
|
||||
creating a <CODE>TopicPublisher</CODE>. A <CODE>MessageProducer</CODE> object is
|
||||
recommended when creating new code. The <CODE>TopicPublisher</CODE> is
|
||||
provided to support existing code.
|
||||
|
||||
|
||||
<P>Because <CODE>TopicPublisher</CODE> inherits from
|
||||
<CODE>MessageProducer</CODE>, it inherits the
|
||||
<CODE>send</CODE> methods that are a part of the <CODE>MessageProducer</CODE>
|
||||
interface. Using the <CODE>send</CODE> methods will have the same
|
||||
effect as using the
|
||||
<CODE>publish</CODE> methods: they are functionally the same.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createProducer(javax.jms.Destination)"><CODE>Session.createProducer(Destination)</CODE></A>,
|
||||
<A HREF="TopicSession.html#createPublisher(javax.jms.Topic)"><CODE>TopicSession.createPublisher(Topic)</CODE></A></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="Topic.html" title="interface in javax.jms">Topic</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicPublisher.html#getTopic()">getTopic</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the topic associated with this <CODE>TopicPublisher</CODE>.</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="TopicPublisher.html#publish(javax.jms.Message)">publish</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Publishes a message to the topic.</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="TopicPublisher.html#publish(javax.jms.Message, int, int, long)">publish</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Publishes a message to the topic, specifying delivery mode,
|
||||
priority, and time to live.</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="TopicPublisher.html#publish(javax.jms.Topic, javax.jms.Message)">publish</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Publishes a message to a topic for an unidentified message producer.</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="TopicPublisher.html#publish(javax.jms.Topic, javax.jms.Message, int, int, long)">publish</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)</CODE>
|
||||
|
||||
<BR>
|
||||
Publishes a message to a topic for an unidentified message
|
||||
producer, specifying delivery mode, priority and time to live.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.MessageProducer"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="MessageProducer.html#close()">close</A>, <A HREF="MessageProducer.html#getDeliveryMode()">getDeliveryMode</A>, <A HREF="MessageProducer.html#getDestination()">getDestination</A>, <A HREF="MessageProducer.html#getDisableMessageID()">getDisableMessageID</A>, <A HREF="MessageProducer.html#getDisableMessageTimestamp()">getDisableMessageTimestamp</A>, <A HREF="MessageProducer.html#getPriority()">getPriority</A>, <A HREF="MessageProducer.html#getTimeToLive()">getTimeToLive</A>, <A HREF="MessageProducer.html#send(javax.jms.Destination, javax.jms.Message)">send</A>, <A HREF="MessageProducer.html#send(javax.jms.Destination, javax.jms.Message, int, int, long)">send</A>, <A HREF="MessageProducer.html#send(javax.jms.Message)">send</A>, <A HREF="MessageProducer.html#send(javax.jms.Message, int, int, long)">send</A>, <A HREF="MessageProducer.html#setDeliveryMode(int)">setDeliveryMode</A>, <A HREF="MessageProducer.html#setDisableMessageID(boolean)">setDisableMessageID</A>, <A HREF="MessageProducer.html#setDisableMessageTimestamp(boolean)">setDisableMessageTimestamp</A>, <A HREF="MessageProducer.html#setPriority(int)">setPriority</A>, <A HREF="MessageProducer.html#setTimeToLive(long)">setTimeToLive</A></CODE></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="getTopic()"><!-- --></A><H3>
|
||||
getTopic</H3>
|
||||
<PRE>
|
||||
<A HREF="Topic.html" title="interface in javax.jms">Topic</A> <B>getTopic</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the topic associated with this <CODE>TopicPublisher</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this publisher's topic
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the topic for
|
||||
this <CODE>TopicPublisher</CODE>
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="publish(javax.jms.Message)"><!-- --></A><H3>
|
||||
publish</H3>
|
||||
<PRE>
|
||||
void <B>publish</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Publishes a message to the topic.
|
||||
Uses the <CODE>TopicPublisher</CODE>'s default delivery mode, priority,
|
||||
and time to live.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to publish
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to publish the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses this method
|
||||
with a <CODE>TopicPublisher</CODE> with
|
||||
an invalid topic.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>TopicPublisher</CODE> that
|
||||
did not specify a topic at creation time.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getDeliveryMode()"><CODE>MessageProducer.getDeliveryMode()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getTimeToLive()"><CODE>MessageProducer.getTimeToLive()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getPriority()"><CODE>MessageProducer.getPriority()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="publish(javax.jms.Message, int, int, long)"><!-- --></A><H3>
|
||||
publish</H3>
|
||||
<PRE>
|
||||
void <B>publish</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Publishes a message to the topic, specifying delivery mode,
|
||||
priority, and time to live.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to publish<DD><CODE>deliveryMode</CODE> - the delivery mode to use<DD><CODE>priority</CODE> - the priority for this message<DD><CODE>timeToLive</CODE> - the message's lifetime (in milliseconds)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to publish the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses this method
|
||||
with a <CODE>TopicPublisher</CODE> with
|
||||
an invalid topic.
|
||||
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if a client uses this
|
||||
method with a <CODE>TopicPublisher</CODE> that
|
||||
did not specify a topic at creation time.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="publish(javax.jms.Topic, javax.jms.Message)"><!-- --></A><H3>
|
||||
publish</H3>
|
||||
<PRE>
|
||||
void <B>publish</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Publishes a message to a topic for an unidentified message producer.
|
||||
Uses the <CODE>TopicPublisher</CODE>'s default delivery mode,
|
||||
priority, and time to live.
|
||||
|
||||
<P>Typically, a message producer is assigned a topic at creation
|
||||
time; however, the JMS API also supports unidentified message producers,
|
||||
which require that the topic be supplied every time a message is
|
||||
published.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the topic to publish this message to<DD><CODE>message</CODE> - the message to publish
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to publish the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with an invalid topic.<DT><B>See Also:</B><DD><A HREF="MessageProducer.html#getDeliveryMode()"><CODE>MessageProducer.getDeliveryMode()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getTimeToLive()"><CODE>MessageProducer.getTimeToLive()</CODE></A>,
|
||||
<A HREF="MessageProducer.html#getPriority()"><CODE>MessageProducer.getPriority()</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="publish(javax.jms.Topic, javax.jms.Message, int, int, long)"><!-- --></A><H3>
|
||||
publish</H3>
|
||||
<PRE>
|
||||
void <B>publish</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
<A HREF="Message.html" title="interface in javax.jms">Message</A> message,
|
||||
int deliveryMode,
|
||||
int priority,
|
||||
long timeToLive)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Publishes a message to a topic for an unidentified message
|
||||
producer, specifying delivery mode, priority and time to live.
|
||||
|
||||
<P>Typically, a message producer is assigned a topic at creation
|
||||
time; however, the JMS API also supports unidentified message producers,
|
||||
which require that the topic be supplied every time a message is
|
||||
published.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the topic to publish this message to<DD><CODE>message</CODE> - the message to publish<DD><CODE>deliveryMode</CODE> - the delivery mode to use<DD><CODE>priority</CODE> - the priority for this message<DD><CODE>timeToLive</CODE> - the message's lifetime (in milliseconds)
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to publish the message
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if an invalid message is specified.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if a client uses
|
||||
this method with an invalid topic.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TopicPublisher.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicRequestor.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicPublisher.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicPublisher.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="TopicPublisher.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicPublisher.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,324 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TopicRequestor (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TopicRequestor class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TopicRequestor (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TopicRequestor.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicPublisher.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicRequestor.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicRequestor.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="TopicRequestor.html#constructor_summary">CONSTR</A> | <A HREF="TopicRequestor.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="TopicRequestor.html#constructor_detail">CONSTR</A> | <A HREF="TopicRequestor.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class TopicRequestor</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.TopicRequestor</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>TopicRequestor</B><DT>extends java.lang.Object</DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The <CODE>TopicRequestor</CODE> helper class simplifies
|
||||
making service requests.
|
||||
|
||||
<P>The <CODE>TopicRequestor</CODE> constructor is given a non-transacted
|
||||
<CODE>TopicSession</CODE> and a destination <CODE>Topic</CODE>. It creates a
|
||||
<CODE>TemporaryTopic</CODE> for the responses and provides a
|
||||
<CODE>request</CODE> method that sends the request message and waits
|
||||
for its reply.
|
||||
|
||||
<P>This is a basic request/reply abstraction that should be sufficient
|
||||
for most uses. JMS providers and clients are free to create more
|
||||
sophisticated versions.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="QueueRequestor.html" title="class in javax.jms"><CODE>QueueRequestor</CODE></A></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="TopicRequestor.html#TopicRequestor(javax.jms.TopicSession, javax.jms.Topic)">TopicRequestor</A></B>(<A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A> session,
|
||||
<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructor for the <CODE>TopicRequestor</CODE> class.</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> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicRequestor.html#close()">close</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Closes the <CODE>TopicRequestor</CODE> and its session.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Message.html" title="interface in javax.jms">Message</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicRequestor.html#request(javax.jms.Message)">request</A></B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends a request and waits for a reply.</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="TopicRequestor(javax.jms.TopicSession, javax.jms.Topic)"><!-- --></A><H3>
|
||||
TopicRequestor</H3>
|
||||
<PRE>
|
||||
public <B>TopicRequestor</B>(<A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A> session,
|
||||
<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Constructor for the <CODE>TopicRequestor</CODE> class.
|
||||
|
||||
<P>This implementation assumes the session parameter to be non-transacted,
|
||||
with a delivery mode of either <CODE>AUTO_ACKNOWLEDGE</CODE> or
|
||||
<CODE>DUPS_OK_ACKNOWLEDGE</CODE>.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the <CODE>TopicSession</CODE> the topic belongs to<DD><CODE>topic</CODE> - the topic to perform the request/reply call on
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create the
|
||||
<CODE>TopicRequestor</CODE> due to some internal
|
||||
error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.</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="close()"><!-- --></A><H3>
|
||||
close</H3>
|
||||
<PRE>
|
||||
public void <B>close</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Closes the <CODE>TopicRequestor</CODE> and its session.
|
||||
|
||||
<P>Since a provider may allocate some resources on behalf of a
|
||||
<CODE>TopicRequestor</CODE> outside the Java virtual machine, clients
|
||||
should close them when they
|
||||
are not needed. Relying on garbage collection to eventually reclaim
|
||||
these resources may not be timely enough.
|
||||
|
||||
<P>Note that this method closes the <CODE>TopicSession</CODE> object
|
||||
passed to the <CODE>TopicRequestor</CODE> constructor.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to close the
|
||||
<CODE>TopicRequestor</CODE> due to some internal
|
||||
error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="request(javax.jms.Message)"><!-- --></A><H3>
|
||||
request</H3>
|
||||
<PRE>
|
||||
public <A HREF="Message.html" title="interface in javax.jms">Message</A> <B>request</B>(<A HREF="Message.html" title="interface in javax.jms">Message</A> message)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Sends a request and waits for a reply. The temporary topic is used for
|
||||
the <CODE>JMSReplyTo</CODE> destination; the first reply is returned,
|
||||
and any following replies are discarded.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send
|
||||
<DT><B>Returns:</B><DD>the reply message
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to complete the
|
||||
request due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TopicRequestor.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicPublisher.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicRequestor.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicRequestor.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="TopicRequestor.html#constructor_summary">CONSTR</A> | <A HREF="TopicRequestor.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="TopicRequestor.html#constructor_detail">CONSTR</A> | <A HREF="TopicRequestor.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,606 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TopicSession (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TopicSession interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TopicSession (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TopicSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicRequestor.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicSession.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="TopicSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicSession.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TopicSession</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD>java.lang.Runnable, <A HREF="Session.html" title="interface in javax.jms">Session</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TopicSession</B><DT>extends <A HREF="Session.html" title="interface in javax.jms">Session</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A <CODE>TopicSession</CODE> object provides methods for creating
|
||||
<CODE>TopicPublisher</CODE>, <CODE>TopicSubscriber</CODE>, and
|
||||
<CODE>TemporaryTopic</CODE> objects. It also provides a method for
|
||||
deleting its client's durable subscribers.
|
||||
|
||||
<P>A <CODE>TopicSession</CODE> is used for creating Pub/Sub specific
|
||||
objects. In general, use the <CODE>Session</CODE> object, and
|
||||
use <CODE>TopicSession</CODE> only to support
|
||||
existing code. Using the <CODE>Session</CODE> object simplifies the
|
||||
programming model, and allows transactions to be used across the two
|
||||
messaging domains.
|
||||
|
||||
<P>A <CODE>TopicSession</CODE> cannot be used to create objects specific to the
|
||||
point-to-point domain. The following methods inherit from
|
||||
<CODE>Session</CODE>, but must throw an
|
||||
<CODE>IllegalStateException</CODE>
|
||||
if used from <CODE>TopicSession</CODE>:
|
||||
<UL>
|
||||
<LI><CODE>createBrowser</CODE>
|
||||
<LI><CODE>createQueue</CODE>
|
||||
<LI><CODE>createTemporaryQueue</CODE>
|
||||
</UL>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html" title="interface in javax.jms"><CODE>Session</CODE></A>,
|
||||
<A HREF="Connection.html#createSession(boolean, int)"><CODE>Connection.createSession(boolean, int)</CODE></A>,
|
||||
<A HREF="TopicConnection.html#createTopicSession(boolean, int)"><CODE>TopicConnection.createTopicSession(boolean, int)</CODE></A>,
|
||||
<A HREF="XATopicSession.html#getTopicSession()"><CODE>XATopicSession.getTopicSession()</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#AUTO_ACKNOWLEDGE">AUTO_ACKNOWLEDGE</A>, <A HREF="Session.html#CLIENT_ACKNOWLEDGE">CLIENT_ACKNOWLEDGE</A>, <A HREF="Session.html#DUPS_OK_ACKNOWLEDGE">DUPS_OK_ACKNOWLEDGE</A>, <A HREF="Session.html#SESSION_TRANSACTED">SESSION_TRANSACTED</A></CODE></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="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)">createDurableSubscriber</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String name)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a durable subscriber to the specified topic.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)">createDurableSubscriber</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String name,
|
||||
java.lang.String messageSelector,
|
||||
boolean noLocal)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a durable subscriber to the specified topic, using a
|
||||
message selector or specifying whether messages published by its
|
||||
own connection should be delivered to it.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TopicPublisher.html" title="interface in javax.jms">TopicPublisher</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createPublisher(javax.jms.Topic)">createPublisher</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a publisher for the specified topic.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createSubscriber(javax.jms.Topic)">createSubscriber</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a nondurable subscriber to the specified topic.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createSubscriber(javax.jms.Topic, java.lang.String, boolean)">createSubscriber</A></B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String messageSelector,
|
||||
boolean noLocal)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a nondurable subscriber to the specified topic, using a
|
||||
message selector or specifying whether messages published by its
|
||||
own connection should be delivered to it.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="TemporaryTopic.html" title="interface in javax.jms">TemporaryTopic</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createTemporaryTopic()">createTemporaryTopic</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a <CODE>TemporaryTopic</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Topic.html" title="interface in javax.jms">Topic</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSession.html#createTopic(java.lang.String)">createTopic</A></B>(java.lang.String topicName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a topic identity given a <CODE>Topic</CODE> name.</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="TopicSession.html#unsubscribe(java.lang.String)">unsubscribe</A></B>(java.lang.String name)</CODE>
|
||||
|
||||
<BR>
|
||||
Unsubscribes a durable subscription that has been created by a client.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#close()">close</A>, <A HREF="Session.html#commit()">commit</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue)">createBrowser</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue, java.lang.String)">createBrowser</A>, <A HREF="Session.html#createBytesMessage()">createBytesMessage</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String, boolean)">createConsumer</A>, <A HREF="Session.html#createMapMessage()">createMapMessage</A>, <A HREF="Session.html#createMessage()">createMessage</A>, <A HREF="Session.html#createObjectMessage()">createObjectMessage</A>, <A HREF="Session.html#createObjectMessage(java.io.Serializable)">createObjectMessage</A>, <A HREF="Session.html#createProducer(javax.jms.Destination)">createProducer</A>, <A HREF="Session.html#createQueue(java.lang.String)">createQueue</A>, <A HREF="Session.html#createStreamMessage()">createStreamMessage</A>, <A HREF="Session.html#createTemporaryQueue()">createTemporaryQueue</A>, <A HREF="Session.html#createTextMessage()">createTextMessage</A>, <A HREF="Session.html#createTextMessage(java.lang.String)">createTextMessage</A>, <A HREF="Session.html#getAcknowledgeMode()">getAcknowledgeMode</A>, <A HREF="Session.html#getMessageListener()">getMessageListener</A>, <A HREF="Session.html#getTransacted()">getTransacted</A>, <A HREF="Session.html#recover()">recover</A>, <A HREF="Session.html#rollback()">rollback</A>, <A HREF="Session.html#run()">run</A>, <A HREF="Session.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A></CODE></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="createDurableSubscriber(javax.jms.Topic, java.lang.String)"><!-- --></A><H3>
|
||||
createDurableSubscriber</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A> <B>createDurableSubscriber</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String name)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a durable subscriber to the specified topic.
|
||||
|
||||
<P>If a client needs to receive all the messages published on a
|
||||
topic, including the ones published while the subscriber is inactive,
|
||||
it uses a durable <CODE>TopicSubscriber</CODE>. The JMS provider
|
||||
retains a record of this
|
||||
durable subscription and insures that all messages from the topic's
|
||||
publishers are retained until they are acknowledged by this
|
||||
durable subscriber or they have expired.
|
||||
|
||||
<P>Sessions with durable subscribers must always provide the same
|
||||
client identifier. In addition, each client must specify a name that
|
||||
uniquely identifies (within client identifier) each durable
|
||||
subscription it creates. Only one session at a time can have a
|
||||
<CODE>TopicSubscriber</CODE> for a particular durable subscription.
|
||||
|
||||
<P>A client can change an existing durable subscription by creating
|
||||
a durable <CODE>TopicSubscriber</CODE> with the same name and a new
|
||||
topic and/or
|
||||
message selector. Changing a durable subscriber is equivalent to
|
||||
unsubscribing (deleting) the old one and creating a new one.
|
||||
|
||||
<P>In some cases, a connection may both publish and subscribe to a
|
||||
topic. The subscriber <CODE>NoLocal</CODE> attribute allows a subscriber
|
||||
to inhibit the delivery of messages published by its own connection.
|
||||
The default value for this attribute is false.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)">createDurableSubscriber</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the non-temporary <CODE>Topic</CODE> to subscribe to<DD><CODE>name</CODE> - the name used to identify this subscription
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a subscriber
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
|
||||
createDurableSubscriber</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A> <B>createDurableSubscriber</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String name,
|
||||
java.lang.String messageSelector,
|
||||
boolean noLocal)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a durable subscriber to the specified topic, using a
|
||||
message selector or specifying whether messages published by its
|
||||
own connection should be delivered to it.
|
||||
|
||||
<P>If a client needs to receive all the messages published on a
|
||||
topic, including the ones published while the subscriber is inactive,
|
||||
it uses a durable <CODE>TopicSubscriber</CODE>. The JMS provider
|
||||
retains a record of this
|
||||
durable subscription and insures that all messages from the topic's
|
||||
publishers are retained until they are acknowledged by this
|
||||
durable subscriber or they have expired.
|
||||
|
||||
<P>Sessions with durable subscribers must always provide the same
|
||||
client identifier. In addition, each client must specify a name which
|
||||
uniquely identifies (within client identifier) each durable
|
||||
subscription it creates. Only one session at a time can have a
|
||||
<CODE>TopicSubscriber</CODE> for a particular durable subscription.
|
||||
An inactive durable subscriber is one that exists but
|
||||
does not currently have a message consumer associated with it.
|
||||
|
||||
<P>A client can change an existing durable subscription by creating
|
||||
a durable <CODE>TopicSubscriber</CODE> with the same name and a new
|
||||
topic and/or
|
||||
message selector. Changing a durable subscriber is equivalent to
|
||||
unsubscribing (deleting) the old one and creating a new one.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)">createDurableSubscriber</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the non-temporary <CODE>Topic</CODE> to subscribe to<DD><CODE>name</CODE> - the name used to identify this subscription<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>noLocal</CODE> - if set, inhibits the delivery of messages published
|
||||
by its own connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a subscriber
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createPublisher(javax.jms.Topic)"><!-- --></A><H3>
|
||||
createPublisher</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicPublisher.html" title="interface in javax.jms">TopicPublisher</A> <B>createPublisher</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a publisher for the specified topic.
|
||||
|
||||
<P>A client uses a <CODE>TopicPublisher</CODE> object to publish
|
||||
messages on a topic.
|
||||
Each time a client creates a <CODE>TopicPublisher</CODE> on a topic, it
|
||||
defines a
|
||||
new sequence of messages that have no ordering relationship with the
|
||||
messages it has previously sent.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the <CODE>Topic</CODE> to publish to, or null if this is an
|
||||
unidentified producer
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a publisher
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createSubscriber(javax.jms.Topic)"><!-- --></A><H3>
|
||||
createSubscriber</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A> <B>createSubscriber</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a nondurable subscriber to the specified topic.
|
||||
|
||||
<P>A client uses a <CODE>TopicSubscriber</CODE> object to receive
|
||||
messages that have been published to a topic.
|
||||
|
||||
<P>Regular <CODE>TopicSubscriber</CODE> objects are not durable.
|
||||
They receive only messages that are published while they are active.
|
||||
|
||||
<P>In some cases, a connection may both publish and subscribe to a
|
||||
topic. The subscriber <CODE>NoLocal</CODE> attribute allows a subscriber
|
||||
to inhibit the delivery of messages published by its own connection.
|
||||
The default value for this attribute is false.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the <CODE>Topic</CODE> to subscribe to
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a subscriber
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createSubscriber(javax.jms.Topic, java.lang.String, boolean)"><!-- --></A><H3>
|
||||
createSubscriber</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A> <B>createSubscriber</B>(<A HREF="Topic.html" title="interface in javax.jms">Topic</A> topic,
|
||||
java.lang.String messageSelector,
|
||||
boolean noLocal)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a nondurable subscriber to the specified topic, using a
|
||||
message selector or specifying whether messages published by its
|
||||
own connection should be delivered to it.
|
||||
|
||||
<P>A client uses a <CODE>TopicSubscriber</CODE> object to receive
|
||||
messages that have been published to a topic.
|
||||
|
||||
<P>Regular <CODE>TopicSubscriber</CODE> objects are not durable.
|
||||
They receive only messages that are published while they are active.
|
||||
|
||||
<P>Messages filtered out by a subscriber's message selector will
|
||||
never be delivered to the subscriber. From the subscriber's
|
||||
perspective, they do not exist.
|
||||
|
||||
<P>In some cases, a connection may both publish and subscribe to a
|
||||
topic. The subscriber <CODE>NoLocal</CODE> attribute allows a subscriber
|
||||
to inhibit the delivery of messages published by its own connection.
|
||||
The default value for this attribute is false.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the <CODE>Topic</CODE> to subscribe to<DD><CODE>messageSelector</CODE> - only messages with properties matching the
|
||||
message selector expression are delivered. A value of null or
|
||||
an empty string indicates that there is no message selector
|
||||
for the message consumer.<DD><CODE>noLocal</CODE> - if set, inhibits the delivery of messages published
|
||||
by its own connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a subscriber
|
||||
due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid topic is specified.
|
||||
<DD><CODE><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></CODE> - if the message selector is invalid.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createTemporaryTopic()"><!-- --></A><H3>
|
||||
createTemporaryTopic</H3>
|
||||
<PRE>
|
||||
<A HREF="TemporaryTopic.html" title="interface in javax.jms">TemporaryTopic</A> <B>createTemporaryTopic</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a <CODE>TemporaryTopic</CODE> object. Its lifetime will be that
|
||||
of the <CODE>TopicConnection</CODE> unless it is deleted earlier.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createTemporaryTopic()">createTemporaryTopic</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a temporary topic identity
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a temporary
|
||||
topic due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createTopic(java.lang.String)"><!-- --></A><H3>
|
||||
createTopic</H3>
|
||||
<PRE>
|
||||
<A HREF="Topic.html" title="interface in javax.jms">Topic</A> <B>createTopic</B>(java.lang.String topicName)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates a topic identity given a <CODE>Topic</CODE> name.
|
||||
|
||||
<P>This facility is provided for the rare cases where clients need to
|
||||
dynamically manipulate topic identity. This allows the creation of a
|
||||
topic identity with a provider-specific name. Clients that depend
|
||||
on this ability are not portable.
|
||||
|
||||
<P>Note that this method is not for creating the physical topic.
|
||||
The physical creation of topics is an administrative task and is not
|
||||
to be initiated by the JMS API. The one exception is the
|
||||
creation of temporary topics, which is accomplished with the
|
||||
<CODE>createTemporaryTopic</CODE> method.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#createTopic(java.lang.String)">createTopic</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>topicName</CODE> - the name of this <CODE>Topic</CODE>
|
||||
<DT><B>Returns:</B><DD>a <CODE>Topic</CODE> with the given name
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to create a topic
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="unsubscribe(java.lang.String)"><!-- --></A><H3>
|
||||
unsubscribe</H3>
|
||||
<PRE>
|
||||
void <B>unsubscribe</B>(java.lang.String name)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Unsubscribes a durable subscription that has been created by a client.
|
||||
|
||||
<P>This method deletes the state being maintained on behalf of the
|
||||
subscriber by its provider.
|
||||
|
||||
<P>It is erroneous for a client to delete a durable subscription
|
||||
while there is an active <CODE>TopicSubscriber</CODE> for the
|
||||
subscription, or while a consumed message is part of a pending
|
||||
transaction or has not been acknowledged in the session.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#unsubscribe(java.lang.String)">unsubscribe</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name used to identify this subscription
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the session fails to unsubscribe to the
|
||||
durable subscription due to some internal error.
|
||||
<DD><CODE><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></CODE> - if an invalid subscription name
|
||||
is specified.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TopicSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicRequestor.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicSession.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="TopicSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicSession.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,321 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TopicSubscriber (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TopicSubscriber interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TopicSubscriber (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TopicSubscriber.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TransactionInProgressException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicSubscriber.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicSubscriber.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="TopicSubscriber.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicSubscriber.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface TopicSubscriber</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>TopicSubscriber</B><DT>extends <A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A client uses a <CODE>TopicSubscriber</CODE> object to receive messages that
|
||||
have been published to a topic. A <CODE>TopicSubscriber</CODE> object is the
|
||||
publish/subscribe form of a message consumer. A <CODE>MessageConsumer</CODE>
|
||||
can be created by using <CODE>Session.createConsumer</CODE>.
|
||||
|
||||
<P>A <CODE>TopicSession</CODE> allows the creation of multiple
|
||||
<CODE>TopicSubscriber</CODE> objects per topic. It will deliver each
|
||||
message for a topic to each
|
||||
subscriber eligible to receive it. Each copy of the message
|
||||
is treated as a completely separate message. Work done on one copy has
|
||||
no effect on the others; acknowledging one does not acknowledge the
|
||||
others; one message may be delivered immediately, while another waits
|
||||
for its subscriber to process messages ahead of it.
|
||||
|
||||
<P>Regular <CODE>TopicSubscriber</CODE> objects are not durable. They
|
||||
receive only messages that are published while they are active.
|
||||
|
||||
<P>Messages filtered out by a subscriber's message selector will never
|
||||
be delivered to the subscriber. From the subscriber's perspective, they
|
||||
do not exist.
|
||||
|
||||
<P>In some cases, a connection may both publish and subscribe to a topic.
|
||||
The subscriber <CODE>NoLocal</CODE> attribute allows a subscriber to inhibit
|
||||
the
|
||||
delivery of messages published by its own connection.
|
||||
|
||||
<P>If a client needs to receive all the messages published on a topic,
|
||||
including the ones published while the subscriber is inactive, it uses
|
||||
a durable <CODE>TopicSubscriber</CODE>. The JMS provider retains a record of
|
||||
this durable
|
||||
subscription and insures that all messages from the topic's publishers
|
||||
are retained until they are acknowledged by this durable
|
||||
subscriber or they have expired.
|
||||
|
||||
<P>Sessions with durable subscribers must always provide the same client
|
||||
identifier. In addition, each client must specify a name that uniquely
|
||||
identifies (within client identifier) each durable subscription it creates.
|
||||
Only one session at a time can have a <CODE>TopicSubscriber</CODE> for a
|
||||
particular durable subscription.
|
||||
|
||||
<P>A client can change an existing durable subscription by creating a
|
||||
durable <CODE>TopicSubscriber</CODE> with the same name and a new topic
|
||||
and/or message
|
||||
selector. Changing a durable subscription is equivalent to unsubscribing
|
||||
(deleting) the old one and creating a new one.
|
||||
|
||||
<P>The <CODE>unsubscribe</CODE> method is used to delete a durable
|
||||
subscription. The <CODE>unsubscribe</CODE> method can be used at the
|
||||
<CODE>Session</CODE> or <CODE>TopicSession</CODE> level.
|
||||
This method deletes the state being
|
||||
maintained on behalf of the subscriber by its provider.
|
||||
|
||||
<P>Creating a <CODE>MessageConsumer</CODE> provides the same features as
|
||||
creating a <CODE>TopicSubscriber</CODE>. To create a durable subscriber,
|
||||
use of <CODE>Session.CreateDurableSubscriber</CODE> is recommended. The
|
||||
<CODE>TopicSubscriber</CODE> is provided to support existing code.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#createConsumer(javax.jms.Destination)"><CODE>Session.createConsumer(javax.jms.Destination)</CODE></A>,
|
||||
<A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)"><CODE>Session.createDurableSubscriber(javax.jms.Topic, java.lang.String)</CODE></A>,
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms"><CODE>TopicSession</CODE></A>,
|
||||
<A HREF="TopicSession.html#createSubscriber(javax.jms.Topic)"><CODE>TopicSession.createSubscriber(javax.jms.Topic)</CODE></A>,
|
||||
<A HREF="MessageConsumer.html" title="interface in javax.jms"><CODE>MessageConsumer</CODE></A></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> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSubscriber.html#getNoLocal()">getNoLocal</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the <CODE>NoLocal</CODE> attribute for this subscriber.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Topic.html" title="interface in javax.jms">Topic</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="TopicSubscriber.html#getTopic()">getTopic</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the <CODE>Topic</CODE> associated with this subscriber.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.MessageConsumer"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="MessageConsumer.html#close()">close</A>, <A HREF="MessageConsumer.html#getMessageListener()">getMessageListener</A>, <A HREF="MessageConsumer.html#getMessageSelector()">getMessageSelector</A>, <A HREF="MessageConsumer.html#receive()">receive</A>, <A HREF="MessageConsumer.html#receive(long)">receive</A>, <A HREF="MessageConsumer.html#receiveNoWait()">receiveNoWait</A>, <A HREF="MessageConsumer.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A></CODE></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="getNoLocal()"><!-- --></A><H3>
|
||||
getNoLocal</H3>
|
||||
<PRE>
|
||||
boolean <B>getNoLocal</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the <CODE>NoLocal</CODE> attribute for this subscriber.
|
||||
The default value for this attribute is false.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>true if locally published messages are being inhibited
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the
|
||||
<CODE>NoLocal</CODE> attribute for
|
||||
this topic subscriber
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getTopic()"><!-- --></A><H3>
|
||||
getTopic</H3>
|
||||
<PRE>
|
||||
<A HREF="Topic.html" title="interface in javax.jms">Topic</A> <B>getTopic</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the <CODE>Topic</CODE> associated with this subscriber.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>this subscriber's <CODE>Topic</CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to get the topic for
|
||||
this topic subscriber
|
||||
due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TopicSubscriber.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TransactionInProgressException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTopicSubscriber.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TopicSubscriber.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="TopicSubscriber.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="TopicSubscriber.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,282 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TransactionInProgressException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TransactionInProgressException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TransactionInProgressException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TransactionInProgressException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TransactionRolledBackException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTransactionInProgressException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TransactionInProgressException.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="TransactionInProgressException.html#constructor_summary">CONSTR</A> | <A HREF="TransactionInProgressException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="TransactionInProgressException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class TransactionInProgressException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.TransactionInProgressException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>TransactionInProgressException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception is thrown when an
|
||||
operation is invalid because a transaction is in progress.
|
||||
For instance, an attempt to call <CODE>Session.commit</CODE> when a
|
||||
session is part of a distributed transaction should throw a
|
||||
<CODE>TransactionInProgressException</CODE>.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.TransactionInProgressException">Serialized Form</A></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="TransactionInProgressException.html#TransactionInProgressException(java.lang.String)">TransactionInProgressException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>TransactionInProgressException</CODE> with the
|
||||
specified reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="TransactionInProgressException.html#TransactionInProgressException(java.lang.String, java.lang.String)">TransactionInProgressException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>TransactionInProgressException</CODE> with the
|
||||
specified reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="TransactionInProgressException(java.lang.String)"><!-- --></A><H3>
|
||||
TransactionInProgressException</H3>
|
||||
<PRE>
|
||||
public <B>TransactionInProgressException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>TransactionInProgressException</CODE> with the
|
||||
specified reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TransactionInProgressException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
TransactionInProgressException</H3>
|
||||
<PRE>
|
||||
public <B>TransactionInProgressException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>TransactionInProgressException</CODE> with the
|
||||
specified reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TransactionInProgressException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="TransactionRolledBackException.html" title="class in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTransactionInProgressException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TransactionInProgressException.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="TransactionInProgressException.html#constructor_summary">CONSTR</A> | <A HREF="TransactionInProgressException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="TransactionInProgressException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
TransactionRolledBackException (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.TransactionRolledBackException class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="TransactionRolledBackException (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="TransactionRolledBackException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TransactionInProgressException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTransactionRolledBackException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TransactionRolledBackException.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="TransactionRolledBackException.html#constructor_summary">CONSTR</A> | <A HREF="TransactionRolledBackException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="TransactionRolledBackException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Class TransactionRolledBackException</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="JMSException.html" title="class in javax.jms">javax.jms.JMSException</A>
|
||||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.jms.TransactionRolledBackException</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>TransactionRolledBackException</B><DT>extends <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<P> This exception must be thrown when a
|
||||
call to <CODE>Session.commit</CODE> results in a rollback of the current
|
||||
transaction.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.jms.TransactionRolledBackException">Serialized Form</A></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="TransactionRolledBackException.html#TransactionRolledBackException(java.lang.String)">TransactionRolledBackException</A></B>(java.lang.String reason)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>TransactionRolledBackException</CODE> with the
|
||||
specified reason.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="TransactionRolledBackException.html#TransactionRolledBackException(java.lang.String, java.lang.String)">TransactionRolledBackException</A></B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a <CODE>TransactionRolledBackException</CODE> with the
|
||||
specified reason and error code.</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>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.JMSException"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class javax.jms.<A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="JMSException.html#getErrorCode()">getErrorCode</A>, <A HREF="JMSException.html#getLinkedException()">getLinkedException</A>, <A HREF="JMSException.html#setLinkedException(java.lang.Exception)">setLinkedException</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="TransactionRolledBackException(java.lang.String)"><!-- --></A><H3>
|
||||
TransactionRolledBackException</H3>
|
||||
<PRE>
|
||||
public <B>TransactionRolledBackException</B>(java.lang.String reason)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>TransactionRolledBackException</CODE> with the
|
||||
specified reason. The error code defaults to null.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TransactionRolledBackException(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
TransactionRolledBackException</H3>
|
||||
<PRE>
|
||||
public <B>TransactionRolledBackException</B>(java.lang.String reason,
|
||||
java.lang.String errorCode)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a <CODE>TransactionRolledBackException</CODE> with the
|
||||
specified reason and error code.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - a description of the exception<DD><CODE>errorCode</CODE> - a string specifying the vendor-specific
|
||||
error code</DL>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="TransactionRolledBackException.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TransactionInProgressException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FTransactionRolledBackException.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TransactionRolledBackException.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="TransactionRolledBackException.html#constructor_summary">CONSTR</A> | <A HREF="TransactionRolledBackException.html#methods_inherited_from_class_javax.jms.JMSException">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="TransactionRolledBackException.html#constructor_detail">CONSTR</A> | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,280 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
XAConnection (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XAConnection interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XAConnection (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XAConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TransactionRolledBackException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAConnection.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="XAConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAConnection.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XAConnection</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Connection.html" title="interface in javax.jms">Connection</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A>, <A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XAConnection</B><DT>extends <A HREF="Connection.html" title="interface in javax.jms">Connection</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The <CODE>XAConnection</CODE> interface extends the capability of
|
||||
<CODE>Connection</CODE> by providing an <CODE>XASession</CODE> (optional).
|
||||
|
||||
<P>The <CODE>XAConnection</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="XAQueueConnection.html" title="interface in javax.jms"><CODE>XAQueueConnection</CODE></A>,
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms"><CODE>XATopicConnection</CODE></A></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="Session.html" title="interface in javax.jms">Session</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAConnection.html#createSession(boolean, int)">createSession</A></B>(boolean transacted,
|
||||
int acknowledgeMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>Session</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="XASession.html" title="interface in javax.jms">XASession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAConnection.html#createXASession()">createXASession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>XASession</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></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="createSession(boolean, int)"><!-- --></A><H3>
|
||||
createSession</H3>
|
||||
<PRE>
|
||||
<A HREF="Session.html" title="interface in javax.jms">Session</A> <B>createSession</B>(boolean transacted,
|
||||
int acknowledgeMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>Session</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Connection.html#createSession(boolean, int)">createSession</A></CODE> in interface <CODE><A HREF="Connection.html" title="interface in javax.jms">Connection</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>transacted</CODE> - usage undefined<DD><CODE>acknowledgeMode</CODE> - usage undefined
|
||||
<DT><B>Returns:</B><DD>a <CODE>Session</CODE> object
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>XAConnection</CODE> object
|
||||
fails to create an <CODE>Session</CODE> due to
|
||||
some internal error.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html#AUTO_ACKNOWLEDGE"><CODE>Session.AUTO_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#CLIENT_ACKNOWLEDGE"><CODE>Session.CLIENT_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#DUPS_OK_ACKNOWLEDGE"><CODE>Session.DUPS_OK_ACKNOWLEDGE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createXASession()"><!-- --></A><H3>
|
||||
createXASession</H3>
|
||||
<PRE>
|
||||
<A HREF="XASession.html" title="interface in javax.jms">XASession</A> <B>createXASession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>XASession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created <CODE>XASession</CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>XAConnection</CODE> object
|
||||
fails to create an <CODE>XASession</CODE> due to
|
||||
some internal error.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XAConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="TransactionRolledBackException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAConnection.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="XAConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAConnection.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,281 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
XAConnectionFactory (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XAConnectionFactory interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XAConnectionFactory (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XAConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAConnectionFactory.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="XAConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAConnectionFactory.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XAConnectionFactory</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms">XAQueueConnectionFactory</A>, <A HREF="XATopicConnectionFactory.html" title="interface in javax.jms">XATopicConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XAConnectionFactory</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The <CODE>XAConnectionFactory</CODE> interface is a base interface for the
|
||||
<CODE>XAQueueConnectionFactory</CODE> and
|
||||
<CODE>XATopicConnectionFactory</CODE> interfaces.
|
||||
|
||||
<P>Some application servers provide support for grouping JTS capable
|
||||
resource use into a distributed transaction (optional). To include JMS API transactions
|
||||
in a JTS transaction, an application server requires a JTS aware JMS
|
||||
provider. A JMS provider exposes its JTS support using an
|
||||
<CODE>XAConnectionFactory</CODE> object, which an application server uses
|
||||
to create <CODE>XAConnection</CODE> objects.
|
||||
|
||||
<P><CODE>XAConnectionFactory</CODE> objects are JMS administered objects,
|
||||
just like <CODE>ConnectionFactory</CODE> objects. It is expected that
|
||||
application servers will find them using the Java Naming and Directory
|
||||
Interface (JNDI) API.
|
||||
|
||||
<P>The <CODE>XAConnectionFactory</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><CODE>XAQueueConnectionFactory</CODE></A>,
|
||||
<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><CODE>XATopicConnectionFactory</CODE></A></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="XAConnection.html" title="interface in javax.jms">XAConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAConnectionFactory.html#createXAConnection()">createXAConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>XAConnection</CODE> with the default user identity.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAConnectionFactory.html#createXAConnection(java.lang.String, java.lang.String)">createXAConnection</A></B>(java.lang.String userName,
|
||||
java.lang.String password)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an XA connection with the specified user identity.</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="createXAConnection()"><!-- --></A><H3>
|
||||
createXAConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A> <B>createXAConnection</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>XAConnection</CODE> with the default user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created <CODE>XAConnection</CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create an XA
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createXAConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
createXAConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A> <B>createXAConnection</B>(java.lang.String userName,
|
||||
java.lang.String password)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an XA connection with the specified user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - the caller's user name<DD><CODE>password</CODE> - the caller's password
|
||||
<DT><B>Returns:</B><DD>a newly created XA connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create an XA
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XAConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAConnectionFactory.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="XAConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAConnectionFactory.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,301 @@
|
||||
<!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_19) on Fri Aug 12 11:25:15 EDT 2011 -->
|
||||
<TITLE>
|
||||
XAQueueConnection (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XAQueueConnection interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XAQueueConnection (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XAQueueConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAQueueConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAQueueConnection.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="XAQueueConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAQueueConnection.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XAQueueConnection</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Connection.html" title="interface in javax.jms">Connection</A>, <A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A>, <A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XAQueueConnection</B><DT>extends <A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A>, <A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>XAQueueConnection</CODE> provides the same create options as
|
||||
<CODE>QueueConnection</CODE> (optional).
|
||||
The only difference is that an <CODE>XAConnection</CODE> is by definition
|
||||
transacted.
|
||||
|
||||
<P>The <CODE>XAQueueConnection</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="XAConnection.html" title="interface in javax.jms"><CODE>XAConnection</CODE></A></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="QueueSession.html" title="interface in javax.jms">QueueSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAQueueConnection.html#createQueueSession(boolean, int)">createQueueSession</A></B>(boolean transacted,
|
||||
int acknowledgeMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>XAQueueSession</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="XAQueueSession.html" title="interface in javax.jms">XAQueueSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAQueueConnection.html#createXAQueueSession()">createXAQueueSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>XAQueueSession</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.XAConnection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="XAConnection.html#createSession(boolean, int)">createSession</A>, <A HREF="XAConnection.html#createXASession()">createXASession</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.QueueConnection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="QueueConnection.html#createConnectionConsumer(javax.jms.Queue, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></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="createQueueSession(boolean, int)"><!-- --></A><H3>
|
||||
createQueueSession</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A> <B>createQueueSession</B>(boolean transacted,
|
||||
int acknowledgeMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>XAQueueSession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="QueueConnection.html#createQueueSession(boolean, int)">createQueueSession</A></CODE> in interface <CODE><A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>transacted</CODE> - usage undefined<DD><CODE>acknowledgeMode</CODE> - usage undefined
|
||||
<DT><B>Returns:</B><DD>a newly created <CODE>XAQueueSession</CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>XAQueueConnection</CODE> object
|
||||
fails to create an XA queue session due to some
|
||||
internal error.<DT><B>See Also:</B><DD><A HREF="Session.html#AUTO_ACKNOWLEDGE"><CODE>Session.AUTO_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#CLIENT_ACKNOWLEDGE"><CODE>Session.CLIENT_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#DUPS_OK_ACKNOWLEDGE"><CODE>Session.DUPS_OK_ACKNOWLEDGE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createXAQueueSession()"><!-- --></A><H3>
|
||||
createXAQueueSession</H3>
|
||||
<PRE>
|
||||
<A HREF="XAQueueSession.html" title="interface in javax.jms">XAQueueSession</A> <B>createXAQueueSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>XAQueueSession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created <CODE>XAQueueSession</CODE>
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>XAQueueConnection</CODE> object
|
||||
fails to create an XA queue session due to some
|
||||
internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XAQueueConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAQueueConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAQueueConnection.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="XAQueueConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAQueueConnection.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,297 @@
|
||||
<!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_19) on Fri Aug 12 11:25:16 EDT 2011 -->
|
||||
<TITLE>
|
||||
XAQueueConnectionFactory (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XAQueueConnectionFactory interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XAQueueConnectionFactory (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XAQueueConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAQueueSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAQueueConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAQueueConnectionFactory.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="XAQueueConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAQueueConnectionFactory.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XAQueueConnectionFactory</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A>, <A HREF="QueueConnectionFactory.html" title="interface in javax.jms">QueueConnectionFactory</A>, <A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XAQueueConnectionFactory</B><DT>extends <A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A>, <A HREF="QueueConnectionFactory.html" title="interface in javax.jms">QueueConnectionFactory</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>XAQueueConnectionFactory</CODE> provides the same create options as
|
||||
a <CODE>QueueConnectionFactory</CODE> (optional).
|
||||
|
||||
<P>The <CODE>XATopicConnectionFactory</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><CODE>QueueConnectionFactory</CODE></A>,
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><CODE>XAConnectionFactory</CODE></A></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="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAQueueConnectionFactory.html#createXAQueueConnection()">createXAQueueConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an XA queue connection with the default user identity.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAQueueConnectionFactory.html#createXAQueueConnection(java.lang.String, java.lang.String)">createXAQueueConnection</A></B>(java.lang.String userName,
|
||||
java.lang.String password)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an XA queue connection with the specified user identity.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.XAConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="XAConnectionFactory.html#createXAConnection()">createXAConnection</A>, <A HREF="XAConnectionFactory.html#createXAConnection(java.lang.String, java.lang.String)">createXAConnection</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.QueueConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="QueueConnectionFactory.html" title="interface in javax.jms">QueueConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="QueueConnectionFactory.html#createQueueConnection()">createQueueConnection</A>, <A HREF="QueueConnectionFactory.html#createQueueConnection(java.lang.String, java.lang.String)">createQueueConnection</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.ConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="ConnectionFactory.html#createConnection()">createConnection</A>, <A HREF="ConnectionFactory.html#createConnection(java.lang.String, java.lang.String)">createConnection</A></CODE></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="createXAQueueConnection()"><!-- --></A><H3>
|
||||
createXAQueueConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A> <B>createXAQueueConnection</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an XA queue connection with the default user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created XA queue connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create an XA queue
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createXAQueueConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
createXAQueueConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A> <B>createXAQueueConnection</B>(java.lang.String userName,
|
||||
java.lang.String password)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an XA queue connection with the specified user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - the caller's user name<DD><CODE>password</CODE> - the caller's password
|
||||
<DT><B>Returns:</B><DD>a newly created XA queue connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create an XA queue
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XAQueueConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XAQueueSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAQueueConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAQueueConnectionFactory.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="XAQueueConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAQueueConnectionFactory.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,265 @@
|
||||
<!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_19) on Fri Aug 12 11:25:16 EDT 2011 -->
|
||||
<TITLE>
|
||||
XAQueueSession (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XAQueueSession interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XAQueueSession (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XAQueueSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XASession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAQueueSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAQueueSession.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="XAQueueSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAQueueSession.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XAQueueSession</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD>java.lang.Runnable, <A HREF="Session.html" title="interface in javax.jms">Session</A>, <A HREF="XASession.html" title="interface in javax.jms">XASession</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XAQueueSession</B><DT>extends <A HREF="XASession.html" title="interface in javax.jms">XASession</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>XAQueueSession</CODE> provides a regular <CODE>QueueSession</CODE>,
|
||||
which can be used to
|
||||
create <CODE>QueueReceiver</CODE>, <CODE>QueueSender</CODE>, and
|
||||
<CODE>QueueBrowser</CODE> objects (optional).
|
||||
|
||||
<P>The <CODE>XAQueueSession</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="XASession.html" title="interface in javax.jms"><CODE>XASession</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#AUTO_ACKNOWLEDGE">AUTO_ACKNOWLEDGE</A>, <A HREF="Session.html#CLIENT_ACKNOWLEDGE">CLIENT_ACKNOWLEDGE</A>, <A HREF="Session.html#DUPS_OK_ACKNOWLEDGE">DUPS_OK_ACKNOWLEDGE</A>, <A HREF="Session.html#SESSION_TRANSACTED">SESSION_TRANSACTED</A></CODE></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="QueueSession.html" title="interface in javax.jms">QueueSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XAQueueSession.html#getQueueSession()">getQueueSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the queue session associated with this <CODE>XAQueueSession</CODE>.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.XASession"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="XASession.html" title="interface in javax.jms">XASession</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="XASession.html#commit()">commit</A>, <A HREF="XASession.html#getSession()">getSession</A>, <A HREF="XASession.html#getTransacted()">getTransacted</A>, <A HREF="XASession.html#getXAResource()">getXAResource</A>, <A HREF="XASession.html#rollback()">rollback</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#close()">close</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue)">createBrowser</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue, java.lang.String)">createBrowser</A>, <A HREF="Session.html#createBytesMessage()">createBytesMessage</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String, boolean)">createConsumer</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)">createDurableSubscriber</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)">createDurableSubscriber</A>, <A HREF="Session.html#createMapMessage()">createMapMessage</A>, <A HREF="Session.html#createMessage()">createMessage</A>, <A HREF="Session.html#createObjectMessage()">createObjectMessage</A>, <A HREF="Session.html#createObjectMessage(java.io.Serializable)">createObjectMessage</A>, <A HREF="Session.html#createProducer(javax.jms.Destination)">createProducer</A>, <A HREF="Session.html#createQueue(java.lang.String)">createQueue</A>, <A HREF="Session.html#createStreamMessage()">createStreamMessage</A>, <A HREF="Session.html#createTemporaryQueue()">createTemporaryQueue</A>, <A HREF="Session.html#createTemporaryTopic()">createTemporaryTopic</A>, <A HREF="Session.html#createTextMessage()">createTextMessage</A>, <A HREF="Session.html#createTextMessage(java.lang.String)">createTextMessage</A>, <A HREF="Session.html#createTopic(java.lang.String)">createTopic</A>, <A HREF="Session.html#getAcknowledgeMode()">getAcknowledgeMode</A>, <A HREF="Session.html#getMessageListener()">getMessageListener</A>, <A HREF="Session.html#recover()">recover</A>, <A HREF="Session.html#run()">run</A>, <A HREF="Session.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A>, <A HREF="Session.html#unsubscribe(java.lang.String)">unsubscribe</A></CODE></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="getQueueSession()"><!-- --></A><H3>
|
||||
getQueueSession</H3>
|
||||
<PRE>
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A> <B>getQueueSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the queue session associated with this <CODE>XAQueueSession</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the queue session object
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if an internal error occurs.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XAQueueSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XASession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXAQueueSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XAQueueSession.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="XAQueueSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XAQueueSession.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,405 @@
|
||||
<!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_19) on Fri Aug 12 11:25:16 EDT 2011 -->
|
||||
<TITLE>
|
||||
XASession (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XASession interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XASession (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XASession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAQueueSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXASession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XASession.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="XASession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XASession.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XASession</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD>java.lang.Runnable, <A HREF="Session.html" title="interface in javax.jms">Session</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="XAQueueSession.html" title="interface in javax.jms">XAQueueSession</A>, <A HREF="XATopicSession.html" title="interface in javax.jms">XATopicSession</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XASession</B><DT>extends <A HREF="Session.html" title="interface in javax.jms">Session</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The <CODE>XASession</CODE> interface extends the capability of
|
||||
<CODE>Session</CODE> by adding access to a JMS provider's support for the
|
||||
Java Transaction API (JTA) (optional). This support takes the form of a
|
||||
<CODE>javax.transaction.xa.XAResource</CODE> object. The functionality of
|
||||
this object closely resembles that defined by the standard X/Open XA
|
||||
Resource interface.
|
||||
|
||||
<P>An application server controls the transactional assignment of an
|
||||
<CODE>XASession</CODE> by obtaining its <CODE>XAResource</CODE>. It uses
|
||||
the <CODE>XAResource</CODE> to assign the session to a transaction, prepare
|
||||
and commit work on the transaction, and so on.
|
||||
|
||||
<P>An <CODE>XAResource</CODE> provides some fairly sophisticated facilities
|
||||
for interleaving work on multiple transactions, recovering a list of
|
||||
transactions in progress, and so on. A JTA aware JMS provider must fully
|
||||
implement this functionality. This could be done by using the services
|
||||
of a database that supports XA, or a JMS provider may choose to implement
|
||||
this functionality from scratch.
|
||||
|
||||
<P>A client of the application server is given what it thinks is a
|
||||
regular JMS <CODE>Session</CODE>. Behind the scenes, the application server
|
||||
controls the transaction management of the underlying
|
||||
<CODE>XASession</CODE>.
|
||||
|
||||
<P>The <CODE>XASession</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="Session.html" title="interface in javax.jms"><CODE>Session</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#AUTO_ACKNOWLEDGE">AUTO_ACKNOWLEDGE</A>, <A HREF="Session.html#CLIENT_ACKNOWLEDGE">CLIENT_ACKNOWLEDGE</A>, <A HREF="Session.html#DUPS_OK_ACKNOWLEDGE">DUPS_OK_ACKNOWLEDGE</A>, <A HREF="Session.html#SESSION_TRANSACTED">SESSION_TRANSACTED</A></CODE></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> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XASession.html#commit()">commit</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Throws a <CODE>TransactionInProgressException</CODE>, since it should
|
||||
not be called for an <CODE>XASession</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XASession.html#getSession()">getSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the session associated with this <CODE>XASession</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XASession.html#getTransacted()">getTransacted</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Indicates whether the session is in transacted mode.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> javax.transaction.xa.XAResource</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XASession.html#getXAResource()">getXAResource</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns an XA resource to the caller.</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="XASession.html#rollback()">rollback</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Throws a <CODE>TransactionInProgressException</CODE>, since it should
|
||||
not be called for an <CODE>XASession</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#close()">close</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue)">createBrowser</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue, java.lang.String)">createBrowser</A>, <A HREF="Session.html#createBytesMessage()">createBytesMessage</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String, boolean)">createConsumer</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)">createDurableSubscriber</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)">createDurableSubscriber</A>, <A HREF="Session.html#createMapMessage()">createMapMessage</A>, <A HREF="Session.html#createMessage()">createMessage</A>, <A HREF="Session.html#createObjectMessage()">createObjectMessage</A>, <A HREF="Session.html#createObjectMessage(java.io.Serializable)">createObjectMessage</A>, <A HREF="Session.html#createProducer(javax.jms.Destination)">createProducer</A>, <A HREF="Session.html#createQueue(java.lang.String)">createQueue</A>, <A HREF="Session.html#createStreamMessage()">createStreamMessage</A>, <A HREF="Session.html#createTemporaryQueue()">createTemporaryQueue</A>, <A HREF="Session.html#createTemporaryTopic()">createTemporaryTopic</A>, <A HREF="Session.html#createTextMessage()">createTextMessage</A>, <A HREF="Session.html#createTextMessage(java.lang.String)">createTextMessage</A>, <A HREF="Session.html#createTopic(java.lang.String)">createTopic</A>, <A HREF="Session.html#getAcknowledgeMode()">getAcknowledgeMode</A>, <A HREF="Session.html#getMessageListener()">getMessageListener</A>, <A HREF="Session.html#recover()">recover</A>, <A HREF="Session.html#run()">run</A>, <A HREF="Session.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A>, <A HREF="Session.html#unsubscribe(java.lang.String)">unsubscribe</A></CODE></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="commit()"><!-- --></A><H3>
|
||||
commit</H3>
|
||||
<PRE>
|
||||
void <B>commit</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Throws a <CODE>TransactionInProgressException</CODE>, since it should
|
||||
not be called for an <CODE>XASession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#commit()">commit</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="TransactionInProgressException.html" title="class in javax.jms">TransactionInProgressException</A></CODE> - if the method is called on
|
||||
an <CODE>XASession</CODE>.
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to commit the
|
||||
transaction due to some internal error.
|
||||
<DD><CODE><A HREF="TransactionRolledBackException.html" title="class in javax.jms">TransactionRolledBackException</A></CODE> - if the transaction
|
||||
is rolled back due to some internal error
|
||||
during commit.
|
||||
<DD><CODE><A HREF="IllegalStateException.html" title="class in javax.jms">IllegalStateException</A></CODE> - if the method is not called by a
|
||||
transacted session.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getSession()"><!-- --></A><H3>
|
||||
getSession</H3>
|
||||
<PRE>
|
||||
<A HREF="Session.html" title="interface in javax.jms">Session</A> <B>getSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the session associated with this <CODE>XASession</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the session object
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if an internal error occurs.<DT><B>Since:</B></DT>
|
||||
<DD>1.1</DD>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getTransacted()"><!-- --></A><H3>
|
||||
getTransacted</H3>
|
||||
<PRE>
|
||||
boolean <B>getTransacted</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Indicates whether the session is in transacted mode.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#getTransacted()">getTransacted</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>true
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to return the
|
||||
transaction mode due to some internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getXAResource()"><!-- --></A><H3>
|
||||
getXAResource</H3>
|
||||
<PRE>
|
||||
javax.transaction.xa.XAResource <B>getXAResource</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns an XA resource to the caller.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an XA resource to the caller</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="rollback()"><!-- --></A><H3>
|
||||
rollback</H3>
|
||||
<PRE>
|
||||
void <B>rollback</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Throws a <CODE>TransactionInProgressException</CODE>, since it should
|
||||
not be called for an <CODE>XASession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="Session.html#rollback()">rollback</A></CODE> in interface <CODE><A HREF="Session.html" title="interface in javax.jms">Session</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="TransactionInProgressException.html" title="class in javax.jms">TransactionInProgressException</A></CODE> - if the method is called on
|
||||
an <CODE>XASession</CODE>.
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to roll back the
|
||||
transaction due to some internal error.
|
||||
<DD><CODE><A HREF="IllegalStateException.html" title="class in javax.jms">IllegalStateException</A></CODE> - if the method is not called by a
|
||||
transacted session.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XASession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XAQueueSession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXASession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XASession.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="XASession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XASession.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,300 @@
|
||||
<!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_19) on Fri Aug 12 11:25:16 EDT 2011 -->
|
||||
<TITLE>
|
||||
XATopicConnection (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XATopicConnection interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XATopicConnection (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XATopicConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XASession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXATopicConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XATopicConnection.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="XATopicConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XATopicConnection.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XATopicConnection</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="Connection.html" title="interface in javax.jms">Connection</A>, <A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A>, <A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XATopicConnection</B><DT>extends <A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A>, <A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>XATopicConnection</CODE> provides the same create options as
|
||||
<CODE>TopicConnection</CODE> (optional). The Topic connections created are
|
||||
transactional.
|
||||
|
||||
<P>The <CODE>XATopicConnection</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="XAConnection.html" title="interface in javax.jms"><CODE>XAConnection</CODE></A></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="TopicSession.html" title="interface in javax.jms">TopicSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XATopicConnection.html#createTopicSession(boolean, int)">createTopicSession</A></B>(boolean transacted,
|
||||
int acknowledgeMode)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>XATopicSession</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="XATopicSession.html" title="interface in javax.jms">XATopicSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XATopicConnection.html#createXATopicSession()">createXATopicSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an <CODE>XATopicSession</CODE> object.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.XAConnection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="XAConnection.html#createSession(boolean, int)">createSession</A>, <A HREF="XAConnection.html#createXASession()">createXASession</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.TopicConnection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="TopicConnection.html#createConnectionConsumer(javax.jms.Topic, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="TopicConnection.html#createDurableConnectionConsumer(javax.jms.Topic, java.lang.String, java.lang.String, javax.jms.ServerSessionPool, int)">createDurableConnectionConsumer</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Connection"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Connection.html#close()">close</A>, <A HREF="Connection.html#createConnectionConsumer(javax.jms.Destination, java.lang.String, javax.jms.ServerSessionPool, int)">createConnectionConsumer</A>, <A HREF="Connection.html#getClientID()">getClientID</A>, <A HREF="Connection.html#getExceptionListener()">getExceptionListener</A>, <A HREF="Connection.html#getMetaData()">getMetaData</A>, <A HREF="Connection.html#setClientID(java.lang.String)">setClientID</A>, <A HREF="Connection.html#setExceptionListener(javax.jms.ExceptionListener)">setExceptionListener</A>, <A HREF="Connection.html#start()">start</A>, <A HREF="Connection.html#stop()">stop</A></CODE></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="createTopicSession(boolean, int)"><!-- --></A><H3>
|
||||
createTopicSession</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A> <B>createTopicSession</B>(boolean transacted,
|
||||
int acknowledgeMode)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>XATopicSession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="TopicConnection.html#createTopicSession(boolean, int)">createTopicSession</A></CODE> in interface <CODE><A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>transacted</CODE> - usage undefined<DD><CODE>acknowledgeMode</CODE> - usage undefined
|
||||
<DT><B>Returns:</B><DD>a newly created XA topic session
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>XATopicConnection</CODE> object
|
||||
fails to create an XA topic session due to some
|
||||
internal error.<DT><B>See Also:</B><DD><A HREF="Session.html#AUTO_ACKNOWLEDGE"><CODE>Session.AUTO_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#CLIENT_ACKNOWLEDGE"><CODE>Session.CLIENT_ACKNOWLEDGE</CODE></A>,
|
||||
<A HREF="Session.html#DUPS_OK_ACKNOWLEDGE"><CODE>Session.DUPS_OK_ACKNOWLEDGE</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createXATopicSession()"><!-- --></A><H3>
|
||||
createXATopicSession</H3>
|
||||
<PRE>
|
||||
<A HREF="XATopicSession.html" title="interface in javax.jms">XATopicSession</A> <B>createXATopicSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an <CODE>XATopicSession</CODE> object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created XA topic session
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the <CODE>XATopicConnection</CODE> object
|
||||
fails to create an XA topic session due to some
|
||||
internal error.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XATopicConnection.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XASession.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXATopicConnection.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XATopicConnection.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="XATopicConnection.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XATopicConnection.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,297 @@
|
||||
<!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_19) on Fri Aug 12 11:25:16 EDT 2011 -->
|
||||
<TITLE>
|
||||
XATopicConnectionFactory (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XATopicConnectionFactory interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XATopicConnectionFactory (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XATopicConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XATopicSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXATopicConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XATopicConnectionFactory.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="XATopicConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XATopicConnectionFactory.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XATopicConnectionFactory</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD><A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A>, <A HREF="TopicConnectionFactory.html" title="interface in javax.jms">TopicConnectionFactory</A>, <A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XATopicConnectionFactory</B><DT>extends <A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A>, <A HREF="TopicConnectionFactory.html" title="interface in javax.jms">TopicConnectionFactory</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>XATopicConnectionFactory</CODE> provides the same create options as
|
||||
a <CODE>TopicConnectionFactory</CODE> (optional).
|
||||
|
||||
<P>The <CODE>XATopicConnectionFactory</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than use these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><CODE>TopicConnectionFactory</CODE></A>,
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><CODE>XAConnectionFactory</CODE></A></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="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XATopicConnectionFactory.html#createXATopicConnection()">createXATopicConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an XA topic connection with the default user identity.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XATopicConnectionFactory.html#createXATopicConnection(java.lang.String, java.lang.String)">createXATopicConnection</A></B>(java.lang.String userName,
|
||||
java.lang.String password)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an XA topic connection with the specified user identity.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.XAConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="XAConnectionFactory.html#createXAConnection()">createXAConnection</A>, <A HREF="XAConnectionFactory.html#createXAConnection(java.lang.String, java.lang.String)">createXAConnection</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.TopicConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="TopicConnectionFactory.html" title="interface in javax.jms">TopicConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="TopicConnectionFactory.html#createTopicConnection()">createTopicConnection</A>, <A HREF="TopicConnectionFactory.html#createTopicConnection(java.lang.String, java.lang.String)">createTopicConnection</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.ConnectionFactory"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="ConnectionFactory.html#createConnection()">createConnection</A>, <A HREF="ConnectionFactory.html#createConnection(java.lang.String, java.lang.String)">createConnection</A></CODE></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="createXATopicConnection()"><!-- --></A><H3>
|
||||
createXATopicConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A> <B>createXATopicConnection</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an XA topic connection with the default user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a newly created XA topic connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create an XA topic
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createXATopicConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
createXATopicConnection</H3>
|
||||
<PRE>
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A> <B>createXATopicConnection</B>(java.lang.String userName,
|
||||
java.lang.String password)
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Creates an XA topic connection with the specified user identity.
|
||||
The connection is created in stopped mode. No messages
|
||||
will be delivered until the <code>Connection.start</code> method
|
||||
is explicitly called.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - the caller's user name<DD><CODE>password</CODE> - the caller's password
|
||||
<DT><B>Returns:</B><DD>a newly created XA topic connection
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to create an XA topic
|
||||
connection due to some internal error.
|
||||
<DD><CODE><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></CODE> - if client authentication fails due to
|
||||
an invalid user name or password.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XATopicConnectionFactory.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
<A HREF="XATopicSession.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXATopicConnectionFactory.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XATopicConnectionFactory.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="XATopicConnectionFactory.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XATopicConnectionFactory.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,265 @@
|
||||
<!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_19) on Fri Aug 12 11:25:16 EDT 2011 -->
|
||||
<TITLE>
|
||||
XATopicSession (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms.XATopicSession interface">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="XATopicSession (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="XATopicSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXATopicSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XATopicSession.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="XATopicSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XATopicSession.html#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">
|
||||
javax.jms</FONT>
|
||||
<BR>
|
||||
Interface XATopicSession</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD>java.lang.Runnable, <A HREF="Session.html" title="interface in javax.jms">Session</A>, <A HREF="XASession.html" title="interface in javax.jms">XASession</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>XATopicSession</B><DT>extends <A HREF="XASession.html" title="interface in javax.jms">XASession</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An <CODE>XATopicSession</CODE> provides a regular <CODE>TopicSession</CODE>.
|
||||
which can be used to create <CODE>TopicSubscriber</CODE> and
|
||||
<CODE>TopicPublisher</CODE> objects (optional).
|
||||
|
||||
<P>The <CODE>XATopicSession</CODE> interface is optional. JMS providers
|
||||
are not required to support this interface. This interface is for
|
||||
use by JMS providers to support transactional environments.
|
||||
Client programs are strongly encouraged to use the transactional support
|
||||
available in their environment, rather than using these XA
|
||||
interfaces directly.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="XASession.html" title="interface in javax.jms"><CODE>XASession</CODE></A>,
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms"><CODE>TopicSession</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#AUTO_ACKNOWLEDGE">AUTO_ACKNOWLEDGE</A>, <A HREF="Session.html#CLIENT_ACKNOWLEDGE">CLIENT_ACKNOWLEDGE</A>, <A HREF="Session.html#DUPS_OK_ACKNOWLEDGE">DUPS_OK_ACKNOWLEDGE</A>, <A HREF="Session.html#SESSION_TRANSACTED">SESSION_TRANSACTED</A></CODE></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="TopicSession.html" title="interface in javax.jms">TopicSession</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="XATopicSession.html#getTopicSession()">getTopicSession</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the topic session associated with this <CODE>XATopicSession</CODE>.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.XASession"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="XASession.html" title="interface in javax.jms">XASession</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="XASession.html#commit()">commit</A>, <A HREF="XASession.html#getSession()">getSession</A>, <A HREF="XASession.html#getTransacted()">getTransacted</A>, <A HREF="XASession.html#getXAResource()">getXAResource</A>, <A HREF="XASession.html#rollback()">rollback</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_javax.jms.Session"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Session.html" title="interface in javax.jms">Session</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="Session.html#close()">close</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue)">createBrowser</A>, <A HREF="Session.html#createBrowser(javax.jms.Queue, java.lang.String)">createBrowser</A>, <A HREF="Session.html#createBytesMessage()">createBytesMessage</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String)">createConsumer</A>, <A HREF="Session.html#createConsumer(javax.jms.Destination, java.lang.String, boolean)">createConsumer</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String)">createDurableSubscriber</A>, <A HREF="Session.html#createDurableSubscriber(javax.jms.Topic, java.lang.String, java.lang.String, boolean)">createDurableSubscriber</A>, <A HREF="Session.html#createMapMessage()">createMapMessage</A>, <A HREF="Session.html#createMessage()">createMessage</A>, <A HREF="Session.html#createObjectMessage()">createObjectMessage</A>, <A HREF="Session.html#createObjectMessage(java.io.Serializable)">createObjectMessage</A>, <A HREF="Session.html#createProducer(javax.jms.Destination)">createProducer</A>, <A HREF="Session.html#createQueue(java.lang.String)">createQueue</A>, <A HREF="Session.html#createStreamMessage()">createStreamMessage</A>, <A HREF="Session.html#createTemporaryQueue()">createTemporaryQueue</A>, <A HREF="Session.html#createTemporaryTopic()">createTemporaryTopic</A>, <A HREF="Session.html#createTextMessage()">createTextMessage</A>, <A HREF="Session.html#createTextMessage(java.lang.String)">createTextMessage</A>, <A HREF="Session.html#createTopic(java.lang.String)">createTopic</A>, <A HREF="Session.html#getAcknowledgeMode()">getAcknowledgeMode</A>, <A HREF="Session.html#getMessageListener()">getMessageListener</A>, <A HREF="Session.html#recover()">recover</A>, <A HREF="Session.html#run()">run</A>, <A HREF="Session.html#setMessageListener(javax.jms.MessageListener)">setMessageListener</A>, <A HREF="Session.html#unsubscribe(java.lang.String)">unsubscribe</A></CODE></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="getTopicSession()"><!-- --></A><H3>
|
||||
getTopicSession</H3>
|
||||
<PRE>
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A> <B>getTopicSession</B>()
|
||||
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
||||
<DL>
|
||||
<DD>Gets the topic session associated with this <CODE>XATopicSession</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the topic session object
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if an internal error occurs.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="XATopicSession.html#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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252FXATopicSession.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="XATopicSession.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="XATopicSession.html#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="XATopicSession.html#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,164 @@
|
||||
<!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_19) on Fri Aug 12 11:26:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
javax.jms (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms package">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white">
|
||||
<FONT size="+1" CLASS="FrameTitleFont">
|
||||
<A HREF="package-summary.html" target="classFrame">javax.jms</A></FONT>
|
||||
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
|
||||
<TR>
|
||||
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
|
||||
Interfaces</FONT>
|
||||
<FONT CLASS="FrameItemFont">
|
||||
<BR>
|
||||
<A HREF="BytesMessage.html" title="interface in javax.jms" target="classFrame"><I>BytesMessage</I></A>
|
||||
<BR>
|
||||
<A HREF="Connection.html" title="interface in javax.jms" target="classFrame"><I>Connection</I></A>
|
||||
<BR>
|
||||
<A HREF="ConnectionConsumer.html" title="interface in javax.jms" target="classFrame"><I>ConnectionConsumer</I></A>
|
||||
<BR>
|
||||
<A HREF="ConnectionFactory.html" title="interface in javax.jms" target="classFrame"><I>ConnectionFactory</I></A>
|
||||
<BR>
|
||||
<A HREF="ConnectionMetaData.html" title="interface in javax.jms" target="classFrame"><I>ConnectionMetaData</I></A>
|
||||
<BR>
|
||||
<A HREF="DeliveryMode.html" title="interface in javax.jms" target="classFrame"><I>DeliveryMode</I></A>
|
||||
<BR>
|
||||
<A HREF="Destination.html" title="interface in javax.jms" target="classFrame"><I>Destination</I></A>
|
||||
<BR>
|
||||
<A HREF="ExceptionListener.html" title="interface in javax.jms" target="classFrame"><I>ExceptionListener</I></A>
|
||||
<BR>
|
||||
<A HREF="MapMessage.html" title="interface in javax.jms" target="classFrame"><I>MapMessage</I></A>
|
||||
<BR>
|
||||
<A HREF="Message.html" title="interface in javax.jms" target="classFrame"><I>Message</I></A>
|
||||
<BR>
|
||||
<A HREF="MessageConsumer.html" title="interface in javax.jms" target="classFrame"><I>MessageConsumer</I></A>
|
||||
<BR>
|
||||
<A HREF="MessageListener.html" title="interface in javax.jms" target="classFrame"><I>MessageListener</I></A>
|
||||
<BR>
|
||||
<A HREF="MessageProducer.html" title="interface in javax.jms" target="classFrame"><I>MessageProducer</I></A>
|
||||
<BR>
|
||||
<A HREF="ObjectMessage.html" title="interface in javax.jms" target="classFrame"><I>ObjectMessage</I></A>
|
||||
<BR>
|
||||
<A HREF="Queue.html" title="interface in javax.jms" target="classFrame"><I>Queue</I></A>
|
||||
<BR>
|
||||
<A HREF="QueueBrowser.html" title="interface in javax.jms" target="classFrame"><I>QueueBrowser</I></A>
|
||||
<BR>
|
||||
<A HREF="QueueConnection.html" title="interface in javax.jms" target="classFrame"><I>QueueConnection</I></A>
|
||||
<BR>
|
||||
<A HREF="QueueConnectionFactory.html" title="interface in javax.jms" target="classFrame"><I>QueueConnectionFactory</I></A>
|
||||
<BR>
|
||||
<A HREF="QueueReceiver.html" title="interface in javax.jms" target="classFrame"><I>QueueReceiver</I></A>
|
||||
<BR>
|
||||
<A HREF="QueueSender.html" title="interface in javax.jms" target="classFrame"><I>QueueSender</I></A>
|
||||
<BR>
|
||||
<A HREF="QueueSession.html" title="interface in javax.jms" target="classFrame"><I>QueueSession</I></A>
|
||||
<BR>
|
||||
<A HREF="ServerSession.html" title="interface in javax.jms" target="classFrame"><I>ServerSession</I></A>
|
||||
<BR>
|
||||
<A HREF="ServerSessionPool.html" title="interface in javax.jms" target="classFrame"><I>ServerSessionPool</I></A>
|
||||
<BR>
|
||||
<A HREF="Session.html" title="interface in javax.jms" target="classFrame"><I>Session</I></A>
|
||||
<BR>
|
||||
<A HREF="StreamMessage.html" title="interface in javax.jms" target="classFrame"><I>StreamMessage</I></A>
|
||||
<BR>
|
||||
<A HREF="TemporaryQueue.html" title="interface in javax.jms" target="classFrame"><I>TemporaryQueue</I></A>
|
||||
<BR>
|
||||
<A HREF="TemporaryTopic.html" title="interface in javax.jms" target="classFrame"><I>TemporaryTopic</I></A>
|
||||
<BR>
|
||||
<A HREF="TextMessage.html" title="interface in javax.jms" target="classFrame"><I>TextMessage</I></A>
|
||||
<BR>
|
||||
<A HREF="Topic.html" title="interface in javax.jms" target="classFrame"><I>Topic</I></A>
|
||||
<BR>
|
||||
<A HREF="TopicConnection.html" title="interface in javax.jms" target="classFrame"><I>TopicConnection</I></A>
|
||||
<BR>
|
||||
<A HREF="TopicConnectionFactory.html" title="interface in javax.jms" target="classFrame"><I>TopicConnectionFactory</I></A>
|
||||
<BR>
|
||||
<A HREF="TopicPublisher.html" title="interface in javax.jms" target="classFrame"><I>TopicPublisher</I></A>
|
||||
<BR>
|
||||
<A HREF="TopicSession.html" title="interface in javax.jms" target="classFrame"><I>TopicSession</I></A>
|
||||
<BR>
|
||||
<A HREF="TopicSubscriber.html" title="interface in javax.jms" target="classFrame"><I>TopicSubscriber</I></A>
|
||||
<BR>
|
||||
<A HREF="XAConnection.html" title="interface in javax.jms" target="classFrame"><I>XAConnection</I></A>
|
||||
<BR>
|
||||
<A HREF="XAConnectionFactory.html" title="interface in javax.jms" target="classFrame"><I>XAConnectionFactory</I></A>
|
||||
<BR>
|
||||
<A HREF="XAQueueConnection.html" title="interface in javax.jms" target="classFrame"><I>XAQueueConnection</I></A>
|
||||
<BR>
|
||||
<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms" target="classFrame"><I>XAQueueConnectionFactory</I></A>
|
||||
<BR>
|
||||
<A HREF="XAQueueSession.html" title="interface in javax.jms" target="classFrame"><I>XAQueueSession</I></A>
|
||||
<BR>
|
||||
<A HREF="XASession.html" title="interface in javax.jms" target="classFrame"><I>XASession</I></A>
|
||||
<BR>
|
||||
<A HREF="XATopicConnection.html" title="interface in javax.jms" target="classFrame"><I>XATopicConnection</I></A>
|
||||
<BR>
|
||||
<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms" target="classFrame"><I>XATopicConnectionFactory</I></A>
|
||||
<BR>
|
||||
<A HREF="XATopicSession.html" title="interface in javax.jms" target="classFrame"><I>XATopicSession</I></A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
|
||||
<TR>
|
||||
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
|
||||
Classes</FONT>
|
||||
<FONT CLASS="FrameItemFont">
|
||||
<BR>
|
||||
<A HREF="QueueRequestor.html" title="class in javax.jms" target="classFrame">QueueRequestor</A>
|
||||
<BR>
|
||||
<A HREF="TopicRequestor.html" title="class in javax.jms" target="classFrame">TopicRequestor</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
|
||||
<TR>
|
||||
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
|
||||
Exceptions</FONT>
|
||||
<FONT CLASS="FrameItemFont">
|
||||
<BR>
|
||||
<A HREF="IllegalStateException.html" title="class in javax.jms" target="classFrame">IllegalStateException</A>
|
||||
<BR>
|
||||
<A HREF="InvalidClientIDException.html" title="class in javax.jms" target="classFrame">InvalidClientIDException</A>
|
||||
<BR>
|
||||
<A HREF="InvalidDestinationException.html" title="class in javax.jms" target="classFrame">InvalidDestinationException</A>
|
||||
<BR>
|
||||
<A HREF="InvalidSelectorException.html" title="class in javax.jms" target="classFrame">InvalidSelectorException</A>
|
||||
<BR>
|
||||
<A HREF="JMSException.html" title="class in javax.jms" target="classFrame">JMSException</A>
|
||||
<BR>
|
||||
<A HREF="JMSSecurityException.html" title="class in javax.jms" target="classFrame">JMSSecurityException</A>
|
||||
<BR>
|
||||
<A HREF="MessageEOFException.html" title="class in javax.jms" target="classFrame">MessageEOFException</A>
|
||||
<BR>
|
||||
<A HREF="MessageFormatException.html" title="class in javax.jms" target="classFrame">MessageFormatException</A>
|
||||
<BR>
|
||||
<A HREF="MessageNotReadableException.html" title="class in javax.jms" target="classFrame">MessageNotReadableException</A>
|
||||
<BR>
|
||||
<A HREF="MessageNotWriteableException.html" title="class in javax.jms" target="classFrame">MessageNotWriteableException</A>
|
||||
<BR>
|
||||
<A HREF="ResourceAllocationException.html" title="class in javax.jms" target="classFrame">ResourceAllocationException</A>
|
||||
<BR>
|
||||
<A HREF="TransactionInProgressException.html" title="class in javax.jms" target="classFrame">TransactionInProgressException</A>
|
||||
<BR>
|
||||
<A HREF="TransactionRolledBackException.html" title="class in javax.jms" target="classFrame">TransactionRolledBackException</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,469 @@
|
||||
<!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_19) on Fri Aug 12 11:26:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
javax.jms (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="javax.jms package">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="javax.jms (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="package-summary.html#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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </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="../../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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../com/sonicsw/xqimpl/mgmtapi/config/gen/package-summary.html"><B>PREV PACKAGE</B></A>
|
||||
<A HREF="../management/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-summary.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>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<H2>
|
||||
Package javax.jms
|
||||
</H2>
|
||||
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Interface Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="BytesMessage.html" title="interface in javax.jms">BytesMessage</A></B></TD>
|
||||
<TD>A <CODE>BytesMessage</CODE> object is used to send a message containing a
|
||||
stream of uninterpreted bytes.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="Connection.html" title="interface in javax.jms">Connection</A></B></TD>
|
||||
<TD>A <CODE>Connection</CODE> object is a client's active connection to its JMS
|
||||
provider.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ConnectionConsumer.html" title="interface in javax.jms">ConnectionConsumer</A></B></TD>
|
||||
<TD>For application servers, <CODE>Connection</CODE> objects provide a special
|
||||
facility
|
||||
for creating a <CODE>ConnectionConsumer</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ConnectionFactory.html" title="interface in javax.jms">ConnectionFactory</A></B></TD>
|
||||
<TD>A <CODE>ConnectionFactory</CODE> object encapsulates a set of connection
|
||||
configuration
|
||||
parameters that has been defined by an administrator.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ConnectionMetaData.html" title="interface in javax.jms">ConnectionMetaData</A></B></TD>
|
||||
<TD>A <CODE>ConnectionMetaData</CODE> object provides information describing the
|
||||
<CODE>Connection</CODE> object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="DeliveryMode.html" title="interface in javax.jms">DeliveryMode</A></B></TD>
|
||||
<TD>The delivery modes supported by the JMS API are <CODE>PERSISTENT</CODE> and
|
||||
<CODE>NON_PERSISTENT</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="Destination.html" title="interface in javax.jms">Destination</A></B></TD>
|
||||
<TD>A <CODE>Destination</CODE> object encapsulates a provider-specific
|
||||
address.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ExceptionListener.html" title="interface in javax.jms">ExceptionListener</A></B></TD>
|
||||
<TD>If a JMS provider detects a serious problem with a <CODE>Connection</CODE>
|
||||
object, it informs the <CODE>Connection</CODE> object's
|
||||
<CODE>ExceptionListener</CODE>, if one has been registered.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MapMessage.html" title="interface in javax.jms">MapMessage</A></B></TD>
|
||||
<TD>A <CODE>MapMessage</CODE> object is used to send a set of name-value pairs.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="Message.html" title="interface in javax.jms">Message</A></B></TD>
|
||||
<TD>The <CODE>Message</CODE> interface is the root interface of all JMS
|
||||
messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageConsumer.html" title="interface in javax.jms">MessageConsumer</A></B></TD>
|
||||
<TD>A client uses a <CODE>MessageConsumer</CODE> object to receive messages
|
||||
from a destination.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageListener.html" title="interface in javax.jms">MessageListener</A></B></TD>
|
||||
<TD>A <CODE>MessageListener</CODE> object is used to receive asynchronously
|
||||
delivered messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageProducer.html" title="interface in javax.jms">MessageProducer</A></B></TD>
|
||||
<TD>A client uses a <CODE>MessageProducer</CODE> object to send messages to a
|
||||
destination.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ObjectMessage.html" title="interface in javax.jms">ObjectMessage</A></B></TD>
|
||||
<TD>An <CODE>ObjectMessage</CODE> object is used to send a message that contains
|
||||
a serializable object in the Java programming language ("Java object").</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="Queue.html" title="interface in javax.jms">Queue</A></B></TD>
|
||||
<TD>A <CODE>Queue</CODE> object encapsulates a provider-specific queue name.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueBrowser.html" title="interface in javax.jms">QueueBrowser</A></B></TD>
|
||||
<TD>A client uses a <CODE>QueueBrowser</CODE> object to look at messages on a
|
||||
queue without removing them.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A></B></TD>
|
||||
<TD>A <CODE>QueueConnection</CODE> object is an active connection to a
|
||||
point-to-point JMS provider.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueConnectionFactory.html" title="interface in javax.jms">QueueConnectionFactory</A></B></TD>
|
||||
<TD>A client uses a <CODE>QueueConnectionFactory</CODE> object to create
|
||||
<CODE>QueueConnection</CODE> objects with a point-to-point JMS provider.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueReceiver.html" title="interface in javax.jms">QueueReceiver</A></B></TD>
|
||||
<TD>A client uses a <CODE>QueueReceiver</CODE> object to receive messages that
|
||||
have been delivered to a queue.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueSender.html" title="interface in javax.jms">QueueSender</A></B></TD>
|
||||
<TD>A client uses a <CODE>QueueSender</CODE> object to send messages to a queue.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueSession.html" title="interface in javax.jms">QueueSession</A></B></TD>
|
||||
<TD>A <CODE>QueueSession</CODE> object provides methods for creating
|
||||
<CODE>QueueReceiver</CODE>, <CODE>QueueSender</CODE>,
|
||||
<CODE>QueueBrowser</CODE>, and <CODE>TemporaryQueue</CODE> objects.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ServerSession.html" title="interface in javax.jms">ServerSession</A></B></TD>
|
||||
<TD>A <CODE>ServerSession</CODE> object is an application server object that
|
||||
is used by a server to associate a thread with a JMS session (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ServerSessionPool.html" title="interface in javax.jms">ServerSessionPool</A></B></TD>
|
||||
<TD>A <CODE>ServerSessionPool</CODE> object is an object implemented by an
|
||||
application server to provide a pool of <CODE>ServerSession</CODE> objects
|
||||
for processing the messages of a <CODE>ConnectionConsumer</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="Session.html" title="interface in javax.jms">Session</A></B></TD>
|
||||
<TD>A <CODE>Session</CODE> object is a single-threaded context for producing and consuming
|
||||
messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="StreamMessage.html" title="interface in javax.jms">StreamMessage</A></B></TD>
|
||||
<TD>A <CODE>StreamMessage</CODE> object is used to send a stream of primitive
|
||||
types in the Java programming language.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TemporaryQueue.html" title="interface in javax.jms">TemporaryQueue</A></B></TD>
|
||||
<TD>A <CODE>TemporaryQueue</CODE> object is a unique <CODE>Queue</CODE> object
|
||||
created for the duration of a <CODE>Connection</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TemporaryTopic.html" title="interface in javax.jms">TemporaryTopic</A></B></TD>
|
||||
<TD>A <CODE>TemporaryTopic</CODE> object is a unique <CODE>Topic</CODE> object
|
||||
created for the duration of a <CODE>Connection</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TextMessage.html" title="interface in javax.jms">TextMessage</A></B></TD>
|
||||
<TD>A <CODE>TextMessage</CODE> object is used to send a message containing a
|
||||
<CODE>java.lang.String</CODE>.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="Topic.html" title="interface in javax.jms">Topic</A></B></TD>
|
||||
<TD>A <CODE>Topic</CODE> object encapsulates a provider-specific topic name.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A></B></TD>
|
||||
<TD>A <CODE>TopicConnection</CODE> object is an active connection to a
|
||||
publish/subscribe JMS provider.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TopicConnectionFactory.html" title="interface in javax.jms">TopicConnectionFactory</A></B></TD>
|
||||
<TD>A client uses a <CODE>TopicConnectionFactory</CODE> object to create
|
||||
<CODE>TopicConnection</CODE> objects with a publish/subscribe JMS provider.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TopicPublisher.html" title="interface in javax.jms">TopicPublisher</A></B></TD>
|
||||
<TD>A client uses a <CODE>TopicPublisher</CODE> object to publish messages on a
|
||||
topic.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TopicSession.html" title="interface in javax.jms">TopicSession</A></B></TD>
|
||||
<TD>A <CODE>TopicSession</CODE> object provides methods for creating
|
||||
<CODE>TopicPublisher</CODE>, <CODE>TopicSubscriber</CODE>, and
|
||||
<CODE>TemporaryTopic</CODE> objects.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TopicSubscriber.html" title="interface in javax.jms">TopicSubscriber</A></B></TD>
|
||||
<TD>A client uses a <CODE>TopicSubscriber</CODE> object to receive messages that
|
||||
have been published to a topic.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A></B></TD>
|
||||
<TD>The <CODE>XAConnection</CODE> interface extends the capability of
|
||||
<CODE>Connection</CODE> by providing an <CODE>XASession</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A></B></TD>
|
||||
<TD>The <CODE>XAConnectionFactory</CODE> interface is a base interface for the
|
||||
<CODE>XAQueueConnectionFactory</CODE> and
|
||||
<CODE>XATopicConnectionFactory</CODE> interfaces.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XAQueueConnection.html" title="interface in javax.jms">XAQueueConnection</A></B></TD>
|
||||
<TD>An <CODE>XAQueueConnection</CODE> provides the same create options as
|
||||
<CODE>QueueConnection</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms">XAQueueConnectionFactory</A></B></TD>
|
||||
<TD>An <CODE>XAQueueConnectionFactory</CODE> provides the same create options as
|
||||
a <CODE>QueueConnectionFactory</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XAQueueSession.html" title="interface in javax.jms">XAQueueSession</A></B></TD>
|
||||
<TD>An <CODE>XAQueueSession</CODE> provides a regular <CODE>QueueSession</CODE>,
|
||||
which can be used to
|
||||
create <CODE>QueueReceiver</CODE>, <CODE>QueueSender</CODE>, and
|
||||
<CODE>QueueBrowser</CODE> objects (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XASession.html" title="interface in javax.jms">XASession</A></B></TD>
|
||||
<TD>The <CODE>XASession</CODE> interface extends the capability of
|
||||
<CODE>Session</CODE> by adding access to a JMS provider's support for the
|
||||
Java Transaction API (JTA) (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XATopicConnection.html" title="interface in javax.jms">XATopicConnection</A></B></TD>
|
||||
<TD>An <CODE>XATopicConnection</CODE> provides the same create options as
|
||||
<CODE>TopicConnection</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XATopicConnectionFactory.html" title="interface in javax.jms">XATopicConnectionFactory</A></B></TD>
|
||||
<TD>An <CODE>XATopicConnectionFactory</CODE> provides the same create options as
|
||||
a <CODE>TopicConnectionFactory</CODE> (optional).</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="XATopicSession.html" title="interface in javax.jms">XATopicSession</A></B></TD>
|
||||
<TD>An <CODE>XATopicSession</CODE> provides a regular <CODE>TopicSession</CODE>.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<P>
|
||||
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Class Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="QueueRequestor.html" title="class in javax.jms">QueueRequestor</A></B></TD>
|
||||
<TD>The <CODE>QueueRequestor</CODE> helper class simplifies
|
||||
making service requests.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TopicRequestor.html" title="class in javax.jms">TopicRequestor</A></B></TD>
|
||||
<TD>The <CODE>TopicRequestor</CODE> helper class simplifies
|
||||
making service requests.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<P>
|
||||
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Exception Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="IllegalStateException.html" title="class in javax.jms">IllegalStateException</A></B></TD>
|
||||
<TD> This exception is thrown when a method is
|
||||
invoked at an illegal or inappropriate time or if the provider is
|
||||
not in an appropriate state for the requested operation.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="InvalidClientIDException.html" title="class in javax.jms">InvalidClientIDException</A></B></TD>
|
||||
<TD> This exception must be thrown when a
|
||||
client attempts to set a connection's client ID to a value that
|
||||
is rejected by a provider.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="InvalidDestinationException.html" title="class in javax.jms">InvalidDestinationException</A></B></TD>
|
||||
<TD> This exception must be thrown when a
|
||||
destination either is not understood by a provider or is no
|
||||
longer valid.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="InvalidSelectorException.html" title="class in javax.jms">InvalidSelectorException</A></B></TD>
|
||||
<TD> This exception must be thrown when a
|
||||
JMS client attempts to give a provider a message selector with
|
||||
invalid syntax.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></B></TD>
|
||||
<TD>This is the root class of all JMS API exceptions.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="JMSSecurityException.html" title="class in javax.jms">JMSSecurityException</A></B></TD>
|
||||
<TD> This exception must be thrown when a provider rejects a user
|
||||
name/password submitted by a client.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageEOFException.html" title="class in javax.jms">MessageEOFException</A></B></TD>
|
||||
<TD> This exception must be thrown when an unexpected
|
||||
end of stream has been reached when a <CODE>StreamMessage</CODE> or
|
||||
<CODE>BytesMessage</CODE> is being read.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></B></TD>
|
||||
<TD> This exception must be thrown when a JMS client
|
||||
attempts to use a data type not supported by a message or attempts to
|
||||
read data in a message as the wrong type.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageNotReadableException.html" title="class in javax.jms">MessageNotReadableException</A></B></TD>
|
||||
<TD> This exception must be thrown when a JMS client attempts to read a
|
||||
write-only message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></B></TD>
|
||||
<TD> This exception must be thrown when a JMS client attempts to write to a
|
||||
read-only message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="ResourceAllocationException.html" title="class in javax.jms">ResourceAllocationException</A></B></TD>
|
||||
<TD>This exception is thrown when a provider is unable to allocate the
|
||||
resources required by a method.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TransactionInProgressException.html" title="class in javax.jms">TransactionInProgressException</A></B></TD>
|
||||
<TD> This exception is thrown when an
|
||||
operation is invalid because a transaction is in progress.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="TransactionRolledBackException.html" title="class in javax.jms">TransactionRolledBackException</A></B></TD>
|
||||
<TD> This exception must be thrown when a
|
||||
call to <CODE>Session.commit</CODE> results in a rollback of the current
|
||||
transaction.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="package-summary.html#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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </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="../../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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../com/sonicsw/xqimpl/mgmtapi/config/gen/package-summary.html"><B>PREV PACKAGE</B></A>
|
||||
<A HREF="../management/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-summary.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>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,201 @@
|
||||
<!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_19) on Fri Aug 12 11:26:13 EDT 2011 -->
|
||||
<TITLE>
|
||||
javax.jms Class Hierarchy (Management Application API)
|
||||
</TITLE>
|
||||
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="javax.jms Class Hierarchy (Management Application API)";
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="package-tree.html#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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../com/sonicsw/xqimpl/mgmtapi/config/gen/package-tree.html"><B>PREV</B></A>
|
||||
<A HREF="../management/package-tree.html"><B>NEXT</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-tree.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>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<CENTER>
|
||||
<H2>
|
||||
Hierarchy For Package javax.jms
|
||||
</H2>
|
||||
</CENTER>
|
||||
<DL>
|
||||
<DT><B>Package Hierarchies:</B><DD><A HREF="../../overview-tree.html">All Packages</A></DL>
|
||||
<HR>
|
||||
<H2>
|
||||
Class Hierarchy
|
||||
</H2>
|
||||
<UL>
|
||||
<LI TYPE="circle">java.lang.Object<UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueRequestor.html" title="class in javax.jms"><B>QueueRequestor</B></A><LI TYPE="circle">java.lang.Throwable (implements java.io.Serializable)
|
||||
<UL>
|
||||
<LI TYPE="circle">java.lang.Exception<UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="JMSException.html" title="class in javax.jms"><B>JMSException</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="IllegalStateException.html" title="class in javax.jms"><B>IllegalStateException</B></A><LI TYPE="circle">javax.jms.<A HREF="InvalidClientIDException.html" title="class in javax.jms"><B>InvalidClientIDException</B></A><LI TYPE="circle">javax.jms.<A HREF="InvalidDestinationException.html" title="class in javax.jms"><B>InvalidDestinationException</B></A><LI TYPE="circle">javax.jms.<A HREF="InvalidSelectorException.html" title="class in javax.jms"><B>InvalidSelectorException</B></A><LI TYPE="circle">javax.jms.<A HREF="JMSSecurityException.html" title="class in javax.jms"><B>JMSSecurityException</B></A><LI TYPE="circle">javax.jms.<A HREF="MessageEOFException.html" title="class in javax.jms"><B>MessageEOFException</B></A><LI TYPE="circle">javax.jms.<A HREF="MessageFormatException.html" title="class in javax.jms"><B>MessageFormatException</B></A><LI TYPE="circle">javax.jms.<A HREF="MessageNotReadableException.html" title="class in javax.jms"><B>MessageNotReadableException</B></A><LI TYPE="circle">javax.jms.<A HREF="MessageNotWriteableException.html" title="class in javax.jms"><B>MessageNotWriteableException</B></A><LI TYPE="circle">javax.jms.<A HREF="ResourceAllocationException.html" title="class in javax.jms"><B>ResourceAllocationException</B></A><LI TYPE="circle">javax.jms.<A HREF="TransactionInProgressException.html" title="class in javax.jms"><B>TransactionInProgressException</B></A><LI TYPE="circle">javax.jms.<A HREF="TransactionRolledBackException.html" title="class in javax.jms"><B>TransactionRolledBackException</B></A></UL>
|
||||
</UL>
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="TopicRequestor.html" title="class in javax.jms"><B>TopicRequestor</B></A></UL>
|
||||
</UL>
|
||||
<H2>
|
||||
Interface Hierarchy
|
||||
</H2>
|
||||
<UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="Connection.html" title="interface in javax.jms"><B>Connection</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueConnection.html" title="interface in javax.jms"><B>QueueConnection</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XAQueueConnection.html" title="interface in javax.jms"><B>XAQueueConnection</B></A> (also extends javax.jms.<A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A>)
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="TopicConnection.html" title="interface in javax.jms"><B>TopicConnection</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XATopicConnection.html" title="interface in javax.jms"><B>XATopicConnection</B></A> (also extends javax.jms.<A HREF="XAConnection.html" title="interface in javax.jms">XAConnection</A>)
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XAConnection.html" title="interface in javax.jms"><B>XAConnection</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XAQueueConnection.html" title="interface in javax.jms"><B>XAQueueConnection</B></A> (also extends javax.jms.<A HREF="QueueConnection.html" title="interface in javax.jms">QueueConnection</A>)
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XATopicConnection.html" title="interface in javax.jms"><B>XATopicConnection</B></A> (also extends javax.jms.<A HREF="TopicConnection.html" title="interface in javax.jms">TopicConnection</A>)
|
||||
</UL>
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="ConnectionConsumer.html" title="interface in javax.jms"><B>ConnectionConsumer</B></A><LI TYPE="circle">javax.jms.<A HREF="ConnectionFactory.html" title="interface in javax.jms"><B>ConnectionFactory</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueConnectionFactory.html" title="interface in javax.jms"><B>QueueConnectionFactory</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><B>XAQueueConnectionFactory</B></A> (also extends javax.jms.<A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A>)
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="TopicConnectionFactory.html" title="interface in javax.jms"><B>TopicConnectionFactory</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><B>XATopicConnectionFactory</B></A> (also extends javax.jms.<A HREF="XAConnectionFactory.html" title="interface in javax.jms">XAConnectionFactory</A>)
|
||||
</UL>
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="ConnectionMetaData.html" title="interface in javax.jms"><B>ConnectionMetaData</B></A><LI TYPE="circle">javax.jms.<A HREF="DeliveryMode.html" title="interface in javax.jms"><B>DeliveryMode</B></A><LI TYPE="circle">javax.jms.<A HREF="Destination.html" title="interface in javax.jms"><B>Destination</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="Queue.html" title="interface in javax.jms"><B>Queue</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="TemporaryQueue.html" title="interface in javax.jms"><B>TemporaryQueue</B></A></UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="Topic.html" title="interface in javax.jms"><B>Topic</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="TemporaryTopic.html" title="interface in javax.jms"><B>TemporaryTopic</B></A></UL>
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="ExceptionListener.html" title="interface in javax.jms"><B>ExceptionListener</B></A><LI TYPE="circle">javax.jms.<A HREF="Message.html" title="interface in javax.jms"><B>Message</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="BytesMessage.html" title="interface in javax.jms"><B>BytesMessage</B></A><LI TYPE="circle">javax.jms.<A HREF="MapMessage.html" title="interface in javax.jms"><B>MapMessage</B></A><LI TYPE="circle">javax.jms.<A HREF="ObjectMessage.html" title="interface in javax.jms"><B>ObjectMessage</B></A><LI TYPE="circle">javax.jms.<A HREF="StreamMessage.html" title="interface in javax.jms"><B>StreamMessage</B></A><LI TYPE="circle">javax.jms.<A HREF="TextMessage.html" title="interface in javax.jms"><B>TextMessage</B></A></UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="MessageConsumer.html" title="interface in javax.jms"><B>MessageConsumer</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueReceiver.html" title="interface in javax.jms"><B>QueueReceiver</B></A><LI TYPE="circle">javax.jms.<A HREF="TopicSubscriber.html" title="interface in javax.jms"><B>TopicSubscriber</B></A></UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="MessageListener.html" title="interface in javax.jms"><B>MessageListener</B></A><LI TYPE="circle">javax.jms.<A HREF="MessageProducer.html" title="interface in javax.jms"><B>MessageProducer</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueSender.html" title="interface in javax.jms"><B>QueueSender</B></A><LI TYPE="circle">javax.jms.<A HREF="TopicPublisher.html" title="interface in javax.jms"><B>TopicPublisher</B></A></UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueBrowser.html" title="interface in javax.jms"><B>QueueBrowser</B></A><LI TYPE="circle">java.lang.Runnable<UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="Session.html" title="interface in javax.jms"><B>Session</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="QueueSession.html" title="interface in javax.jms"><B>QueueSession</B></A><LI TYPE="circle">javax.jms.<A HREF="TopicSession.html" title="interface in javax.jms"><B>TopicSession</B></A><LI TYPE="circle">javax.jms.<A HREF="XASession.html" title="interface in javax.jms"><B>XASession</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XAQueueSession.html" title="interface in javax.jms"><B>XAQueueSession</B></A><LI TYPE="circle">javax.jms.<A HREF="XATopicSession.html" title="interface in javax.jms"><B>XATopicSession</B></A></UL>
|
||||
</UL>
|
||||
</UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="ServerSession.html" title="interface in javax.jms"><B>ServerSession</B></A><LI TYPE="circle">javax.jms.<A HREF="ServerSessionPool.html" title="interface in javax.jms"><B>ServerSessionPool</B></A><LI TYPE="circle">javax.jms.<A HREF="XAConnectionFactory.html" title="interface in javax.jms"><B>XAConnectionFactory</B></A><UL>
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XAQueueConnectionFactory.html" title="interface in javax.jms"><B>XAQueueConnectionFactory</B></A> (also extends javax.jms.<A HREF="QueueConnectionFactory.html" title="interface in javax.jms">QueueConnectionFactory</A>)
|
||||
<LI TYPE="circle">javax.jms.<A HREF="XATopicConnectionFactory.html" title="interface in javax.jms"><B>XATopicConnectionFactory</B></A> (also extends javax.jms.<A HREF="TopicConnectionFactory.html" title="interface in javax.jms">TopicConnectionFactory</A>)
|
||||
</UL>
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="package-tree.html#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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </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>
|
||||
Sonic Management API</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../com/sonicsw/xqimpl/mgmtapi/config/gen/package-tree.html"><B>PREV</B></A>
|
||||
<A HREF="../management/package-tree.html"><B>NEXT</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../index.html@javax%252Fjms%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-tree.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>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
<font size="-1">Copyright © 2001-2011
|
||||
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
||||
<br>HTML formatted on 12-Aug-2011.</font>
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user