source: branches/objectmq-1.0/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/JDKSaslConfig.html

Last change on this file was 33, checked in by amoreno, 11 years ago

new release version
File size: 12.1 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>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_18) on Tue Dec 11 11:47:09 GMT 2012 -->
6<TITLE>
7JDKSaslConfig
8</TITLE>
9
10<META NAME="date" CONTENT="2012-12-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="JDKSaslConfig";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;<A HREF="../../../com/rabbitmq/client/GetResponse.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="../../../index.html?com/rabbitmq/client/JDKSaslConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="JDKSaslConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90com.rabbitmq.client</FONT>
91<BR>
92Class JDKSaslConfig</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.JDKSaslConfig</B>
96</PRE>
97<DL>
98<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public class <B>JDKSaslConfig</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A></DL>
103</PRE>
104
105<P>
106Implementation of SaslConfig that uses the JDK SASL implementation. This is
107 not the default since it does not work on Java 1.4, Android or IBM's JDK.
108<P>
109
110<P>
111<DL>
112<DT><B>See Also:</B><DD><A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client"><CODE>ConnectionFactory</CODE></A></DL>
113<HR>
114
115<P>
116
117<!-- ======== CONSTRUCTOR SUMMARY ======== -->
118
119<A NAME="constructor_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123<B>Constructor Summary</B></FONT></TH>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD><CODE><B><A HREF="../../../com/rabbitmq/client/JDKSaslConfig.html#JDKSaslConfig(com.rabbitmq.client.ConnectionFactory)">JDKSaslConfig</A></B>(<A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client">ConnectionFactory</A>&nbsp;factory)</CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a JDKSaslConfig which only wants to use PLAIN.</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD><CODE><B><A HREF="../../../com/rabbitmq/client/JDKSaslConfig.html#JDKSaslConfig(com.rabbitmq.client.ConnectionFactory, java.lang.String[])">JDKSaslConfig</A></B>(<A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client">ConnectionFactory</A>&nbsp;factory,
133              java.lang.String[]&nbsp;mechanisms)</CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a JDKSaslConfig with a list of mechanisms to use.</TD>
137</TR>
138</TABLE>
139&nbsp;
140<!-- ========== METHOD SUMMARY =========== -->
141
142<A NAME="method_summary"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146<B>Method Summary</B></FONT></TH>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/SaslMechanism.html" title="interface in com.rabbitmq.client">SaslMechanism</A></CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../com/rabbitmq/client/JDKSaslConfig.html#getSaslMechanism(java.lang.String[])">getSaslMechanism</A></B>(java.lang.String[]&nbsp;serverMechanisms)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156</TABLE>
157&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
160<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
164</TR>
165</TABLE>
166&nbsp;
167<P>
168
169<!-- ========= CONSTRUCTOR DETAIL ======== -->
170
171<A NAME="constructor_detail"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
174<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
175<B>Constructor Detail</B></FONT></TH>
176</TR>
177</TABLE>
178
179<A NAME="JDKSaslConfig(com.rabbitmq.client.ConnectionFactory)"><!-- --></A><H3>
180JDKSaslConfig</H3>
181<PRE>
182public <B>JDKSaslConfig</B>(<A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client">ConnectionFactory</A>&nbsp;factory)</PRE>
183<DL>
184<DD>Create a JDKSaslConfig which only wants to use PLAIN.
185<P>
186<DL>
187<DT><B>Parameters:</B><DD><CODE>factory</CODE> - - the ConnectionFactory to use to obtain username, password and host</DL>
188</DL>
189<HR>
190
191<A NAME="JDKSaslConfig(com.rabbitmq.client.ConnectionFactory, java.lang.String[])"><!-- --></A><H3>
192JDKSaslConfig</H3>
193<PRE>
194public <B>JDKSaslConfig</B>(<A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client">ConnectionFactory</A>&nbsp;factory,
195                     java.lang.String[]&nbsp;mechanisms)</PRE>
196<DL>
197<DD>Create a JDKSaslConfig with a list of mechanisms to use.
198<P>
199<DL>
200<DT><B>Parameters:</B><DD><CODE>factory</CODE> - - the ConnectionFactory to use to obtain username, password and host<DD><CODE>mechanisms</CODE> - - a list of SASL mechanisms to use (in descending order of preference)</DL>
201</DL>
202
203<!-- ============ METHOD DETAIL ========== -->
204
205<A NAME="method_detail"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
208<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
209<B>Method Detail</B></FONT></TH>
210</TR>
211</TABLE>
212
213<A NAME="getSaslMechanism(java.lang.String[])"><!-- --></A><H3>
214getSaslMechanism</H3>
215<PRE>
216public <A HREF="../../../com/rabbitmq/client/SaslMechanism.html" title="interface in com.rabbitmq.client">SaslMechanism</A> <B>getSaslMechanism</B>(java.lang.String[]&nbsp;serverMechanisms)</PRE>
217<DL>
218<DD><DL>
219<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/SaslConfig.html#getSaslMechanism(java.lang.String[])">getSaslMechanism</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A></CODE></DL>
220</DD>
221<DD><DL>
222</DL>
223</DD>
224</DL>
225<!-- ========= END OF CLASS DATA ========= -->
226<HR>
227
228
229<!-- ======= START OF BOTTOM NAVBAR ====== -->
230<A NAME="navbar_bottom"><!-- --></A>
231<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
232<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
233<TR>
234<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
235<A NAME="navbar_bottom_firstrow"><!-- --></A>
236<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
237  <TR ALIGN="center" VALIGN="top">
238  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
239  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
240  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
241  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
242  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
243  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
244  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
245  </TR>
246</TABLE>
247</TD>
248<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
249</EM>
250</TD>
251</TR>
252
253<TR>
254<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
255&nbsp;<A HREF="../../../com/rabbitmq/client/GetResponse.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
256&nbsp;<A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
257<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
258  <A HREF="../../../index.html?com/rabbitmq/client/JDKSaslConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;
259&nbsp;<A HREF="JDKSaslConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
260&nbsp;<SCRIPT type="text/javascript">
261  <!--
262  if(window==top) {
263    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
264  }
265  //-->
266</SCRIPT>
267<NOSCRIPT>
268  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
269</NOSCRIPT>
270
271
272</FONT></TD>
273</TR>
274<TR>
275<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
276  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
277<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
278DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
279</TR>
280</TABLE>
281<A NAME="skip-navbar_bottom"></A>
282<!-- ======== END OF BOTTOM NAVBAR ======= -->
283
284<HR>
285
286</BODY>
287</HTML>
Note: See TracBrowser for help on using the repository browser.