source: trunk/doc/omq/common/util/OmqConnectionFactory.html @ 85

Last change on this file since 85 was 85, checked in by stoda, 11 years ago

Javadocs updated
File size: 12.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="es">
4<head>
5<!-- Generated by javadoc (version 1.7.0_25) on Wed Jul 10 13:13:17 CEST 2013 -->
6<title>OmqConnectionFactory</title>
7<meta name="date" content="2013-07-10">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="OmqConnectionFactory";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/OmqConnectionFactory.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../index-files/index-1.html">Index</a></li>
34<li><a href="../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li>Prev Class</li>
40<li><a href="../../../omq/common/util/ParameterQueue.html" title="class in omq.common.util"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../index.html?omq/common/util/OmqConnectionFactory.html" target="_top">Frames</a></li>
44<li><a href="OmqConnectionFactory.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">omq.common.util</div>
83<h2 title="Class OmqConnectionFactory" class="title">Class OmqConnectionFactory</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li>java.lang.Object</li>
88<li>
89<ul class="inheritance">
90<li>omq.common.util.OmqConnectionFactory</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<hr>
98<br>
99<pre>public class <span class="strong">OmqConnectionFactory</span>
100extends java.lang.Object</pre>
101<div class="block">This class creates RabbitMQ connections</div>
102<dl><dt><span class="strong">Author:</span></dt>
103  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd></dl>
104</li>
105</ul>
106</div>
107<div class="summary">
108<ul class="blockList">
109<li class="blockList">
110<!-- ======== CONSTRUCTOR SUMMARY ======== -->
111<ul class="blockList">
112<li class="blockList"><a name="constructor_summary">
113<!--   -->
114</a>
115<h3>Constructor Summary</h3>
116<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
117<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
118<tr>
119<th class="colOne" scope="col">Constructor and Description</th>
120</tr>
121<tr class="altColor">
122<td class="colOne"><code><strong><a href="../../../omq/common/util/OmqConnectionFactory.html#OmqConnectionFactory()">OmqConnectionFactory</a></strong>()</code>&nbsp;</td>
123</tr>
124</table>
125</li>
126</ul>
127<!-- ========== METHOD SUMMARY =========== -->
128<ul class="blockList">
129<li class="blockList"><a name="method_summary">
130<!--   -->
131</a>
132<h3>Method Summary</h3>
133<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
134<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
135<tr>
136<th class="colFirst" scope="col">Modifier and Type</th>
137<th class="colLast" scope="col">Method and Description</th>
138</tr>
139<tr class="altColor">
140<td class="colFirst"><code>static com.rabbitmq.client.Channel</code></td>
141<td class="colLast"><code><strong><a href="../../../omq/common/util/OmqConnectionFactory.html#getNewChannel()">getNewChannel</a></strong>()</code>
142<div class="block">This method creates a new channel if the singleton pattern is used</div>
143</td>
144</tr>
145<tr class="rowColor">
146<td class="colFirst"><code>static com.rabbitmq.client.Connection</code></td>
147<td class="colLast"><code><strong><a href="../../../omq/common/util/OmqConnectionFactory.html#getNewConnection(java.util.Properties)">getNewConnection</a></strong>(java.util.Properties&nbsp;env)</code>
148<div class="block">This function creates a new rabbitmq connection using the properties set
149 in env</div>
150</td>
151</tr>
152<tr class="altColor">
153<td class="colFirst"><code>static com.rabbitmq.client.Connection</code></td>
154<td class="colLast"><code><strong><a href="../../../omq/common/util/OmqConnectionFactory.html#getNewWorkingConnection(java.util.Properties)">getNewWorkingConnection</a></strong>(java.util.Properties&nbsp;env)</code>
155<div class="block">This function returns a working connection.</div>
156</td>
157</tr>
158<tr class="rowColor">
159<td class="colFirst"><code>static void</code></td>
160<td class="colLast"><code><strong><a href="../../../omq/common/util/OmqConnectionFactory.html#init(java.util.Properties)">init</a></strong>(java.util.Properties&nbsp;env)</code>
161<div class="block">If this class is wanted to use as a singleton class this is the init
162 function</div>
163</td>
164</tr>
165</table>
166<ul class="blockList">
167<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
168<!--   -->
169</a>
170<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
171<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
172</ul>
173</li>
174</ul>
175</li>
176</ul>
177</div>
178<div class="details">
179<ul class="blockList">
180<li class="blockList">
181<!-- ========= CONSTRUCTOR DETAIL ======== -->
182<ul class="blockList">
183<li class="blockList"><a name="constructor_detail">
184<!--   -->
185</a>
186<h3>Constructor Detail</h3>
187<a name="OmqConnectionFactory()">
188<!--   -->
189</a>
190<ul class="blockListLast">
191<li class="blockList">
192<h4>OmqConnectionFactory</h4>
193<pre>public&nbsp;OmqConnectionFactory()</pre>
194</li>
195</ul>
196</li>
197</ul>
198<!-- ============ METHOD DETAIL ========== -->
199<ul class="blockList">
200<li class="blockList"><a name="method_detail">
201<!--   -->
202</a>
203<h3>Method Detail</h3>
204<a name="init(java.util.Properties)">
205<!--   -->
206</a>
207<ul class="blockList">
208<li class="blockList">
209<h4>init</h4>
210<pre>public static&nbsp;void&nbsp;init(java.util.Properties&nbsp;env)
211                 throws java.security.KeyManagementException,
212                        java.security.NoSuchAlgorithmException,
213                        java.io.IOException</pre>
214<div class="block">If this class is wanted to use as a singleton class this is the init
215 function</div>
216<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - - environment that sets the properties needed by RabbitMQ</dd>
217<dt><span class="strong">Throws:</span></dt>
218<dd><code>java.security.KeyManagementException</code></dd>
219<dd><code>java.security.NoSuchAlgorithmException</code></dd>
220<dd><code>java.io.IOException</code></dd></dl>
221</li>
222</ul>
223<a name="getNewWorkingConnection(java.util.Properties)">
224<!--   -->
225</a>
226<ul class="blockList">
227<li class="blockList">
228<h4>getNewWorkingConnection</h4>
229<pre>public static&nbsp;com.rabbitmq.client.Connection&nbsp;getNewWorkingConnection(java.util.Properties&nbsp;env)
230                                                              throws java.lang.Exception</pre>
231<div class="block">This function returns a working connection.</div>
232<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - - used if it's necessary to create a new connection</dd>
233<dt><span class="strong">Returns:</span></dt><dd>workingConnection</dd>
234<dt><span class="strong">Throws:</span></dt>
235<dd><code>java.lang.Exception</code></dd></dl>
236</li>
237</ul>
238<a name="getNewConnection(java.util.Properties)">
239<!--   -->
240</a>
241<ul class="blockList">
242<li class="blockList">
243<h4>getNewConnection</h4>
244<pre>public static&nbsp;com.rabbitmq.client.Connection&nbsp;getNewConnection(java.util.Properties&nbsp;env)
245                                                       throws java.io.IOException,
246                                                              java.security.KeyManagementException,
247                                                              java.security.NoSuchAlgorithmException</pre>
248<div class="block">This function creates a new rabbitmq connection using the properties set
249 in env</div>
250<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - - Properties needed to create a new connection: username,
251            password, rabbit_host, rabbit_port, enable_ssl (optional)</dd>
252<dt><span class="strong">Returns:</span></dt><dd>new Connection</dd>
253<dt><span class="strong">Throws:</span></dt>
254<dd><code>java.io.IOException</code></dd>
255<dd><code>java.security.KeyManagementException</code></dd>
256<dd><code>java.security.NoSuchAlgorithmException</code></dd></dl>
257</li>
258</ul>
259<a name="getNewChannel()">
260<!--   -->
261</a>
262<ul class="blockListLast">
263<li class="blockList">
264<h4>getNewChannel</h4>
265<pre>public static&nbsp;com.rabbitmq.client.Channel&nbsp;getNewChannel()
266                                                 throws java.io.IOException</pre>
267<div class="block">This method creates a new channel if the singleton pattern is used</div>
268<dl><dt><span class="strong">Returns:</span></dt><dd>new Channel</dd>
269<dt><span class="strong">Throws:</span></dt>
270<dd><code>java.io.IOException</code></dd></dl>
271</li>
272</ul>
273</li>
274</ul>
275</li>
276</ul>
277</div>
278</div>
279<!-- ========= END OF CLASS DATA ========= -->
280<!-- ======= START OF BOTTOM NAVBAR ====== -->
281<div class="bottomNav"><a name="navbar_bottom">
282<!--   -->
283</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
284<!--   -->
285</a>
286<ul class="navList" title="Navigation">
287<li><a href="../../../overview-summary.html">Overview</a></li>
288<li><a href="package-summary.html">Package</a></li>
289<li class="navBarCell1Rev">Class</li>
290<li><a href="class-use/OmqConnectionFactory.html">Use</a></li>
291<li><a href="package-tree.html">Tree</a></li>
292<li><a href="../../../deprecated-list.html">Deprecated</a></li>
293<li><a href="../../../index-files/index-1.html">Index</a></li>
294<li><a href="../../../help-doc.html">Help</a></li>
295</ul>
296</div>
297<div class="subNav">
298<ul class="navList">
299<li>Prev Class</li>
300<li><a href="../../../omq/common/util/ParameterQueue.html" title="class in omq.common.util"><span class="strong">Next Class</span></a></li>
301</ul>
302<ul class="navList">
303<li><a href="../../../index.html?omq/common/util/OmqConnectionFactory.html" target="_top">Frames</a></li>
304<li><a href="OmqConnectionFactory.html" target="_top">No Frames</a></li>
305</ul>
306<ul class="navList" id="allclasses_navbar_bottom">
307<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
308</ul>
309<div>
310<script type="text/javascript"><!--
311  allClassesLink = document.getElementById("allclasses_navbar_bottom");
312  if(window==top) {
313    allClassesLink.style.display = "block";
314  }
315  else {
316    allClassesLink.style.display = "none";
317  }
318  //-->
319</script>
320</div>
321<div>
322<ul class="subNavList">
323<li>Summary:&nbsp;</li>
324<li>Nested&nbsp;|&nbsp;</li>
325<li>Field&nbsp;|&nbsp;</li>
326<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
327<li><a href="#method_summary">Method</a></li>
328</ul>
329<ul class="subNavList">
330<li>Detail:&nbsp;</li>
331<li>Field&nbsp;|&nbsp;</li>
332<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
333<li><a href="#method_detail">Method</a></li>
334</ul>
335</div>
336<a name="skip-navbar_bottom">
337<!--   -->
338</a></div>
339<!-- ======== END OF BOTTOM NAVBAR ======= -->
340</body>
341</html>
Note: See TracBrowser for help on using the repository browser.