GizzlerandCursor
58b7826162
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>
311 lines
13 KiB
HTML
311 lines
13 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.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>
|