source: branches/objectmq_old/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/impl/ExternalMechanism.html

Last change on this file was 9, checked in by stoda, 12 years ago

First commit
File size: 12.4 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:11 GMT 2012 -->
6<TITLE>
7ExternalMechanism
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="ExternalMechanism";
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/impl/ExceptionHandler.html" title="interface in com.rabbitmq.client.impl"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="../../../../index.html?com/rabbitmq/client/impl/ExternalMechanism.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="ExternalMechanism.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.impl</FONT>
91<BR>
92Class ExternalMechanism</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.impl.ExternalMechanism</B>
96</PRE>
97<DL>
98<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html" title="interface in com.rabbitmq.client">SaslMechanism</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public class <B>ExternalMechanism</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/rabbitmq/client/SaslMechanism.html" title="interface in com.rabbitmq.client">SaslMechanism</A></DL>
103</PRE>
104
105<P>
106The EXTERNAL auth mechanism
107<P>
108
109<P>
110<HR>
111
112<P>
113
114<!-- ======== CONSTRUCTOR SUMMARY ======== -->
115
116<A NAME="constructor_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120<B>Constructor Summary</B></FONT></TH>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ExternalMechanism.html#ExternalMechanism()">ExternalMechanism</A></B>()</CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
127</TR>
128</TABLE>
129&nbsp;
130<!-- ========== METHOD SUMMARY =========== -->
131
132<A NAME="method_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
136<B>Method Summary</B></FONT></TH>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ExternalMechanism.html#getName()">getName</A></B>()</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of this mechanism (e.g.</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;<A HREF="../../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client">LongString</A></CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ExternalMechanism.html#handleChallenge(com.rabbitmq.client.LongString, java.lang.String, java.lang.String)">handleChallenge</A></B>(<A HREF="../../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client">LongString</A>&nbsp;challenge,
150                java.lang.String&nbsp;username,
151                java.lang.String&nbsp;password)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handle one round of challenge-response</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="ExternalMechanism()"><!-- --></A><H3>
180ExternalMechanism</H3>
181<PRE>
182public <B>ExternalMechanism</B>()</PRE>
183<DL>
184</DL>
185
186<!-- ============ METHOD DETAIL ========== -->
187
188<A NAME="method_detail"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
191<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
192<B>Method Detail</B></FONT></TH>
193</TR>
194</TABLE>
195
196<A NAME="getName()"><!-- --></A><H3>
197getName</H3>
198<PRE>
199public java.lang.String <B>getName</B>()</PRE>
200<DL>
201<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html#getName()">SaslMechanism</A></CODE></B></DD>
202<DD>The name of this mechanism (e.g. PLAIN)
203<P>
204<DD><DL>
205<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html" title="interface in com.rabbitmq.client">SaslMechanism</A></CODE></DL>
206</DD>
207<DD><DL>
208
209<DT><B>Returns:</B><DD>the name</DL>
210</DD>
211</DL>
212<HR>
213
214<A NAME="handleChallenge(com.rabbitmq.client.LongString, java.lang.String, java.lang.String)"><!-- --></A><H3>
215handleChallenge</H3>
216<PRE>
217public <A HREF="../../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client">LongString</A> <B>handleChallenge</B>(<A HREF="../../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client">LongString</A>&nbsp;challenge,
218                                  java.lang.String&nbsp;username,
219                                  java.lang.String&nbsp;password)</PRE>
220<DL>
221<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html#handleChallenge(com.rabbitmq.client.LongString, java.lang.String, java.lang.String)">SaslMechanism</A></CODE></B></DD>
222<DD>Handle one round of challenge-response
223<P>
224<DD><DL>
225<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html#handleChallenge(com.rabbitmq.client.LongString, java.lang.String, java.lang.String)">handleChallenge</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/SaslMechanism.html" title="interface in com.rabbitmq.client">SaslMechanism</A></CODE></DL>
226</DD>
227<DD><DL>
228<DT><B>Parameters:</B><DD><CODE>challenge</CODE> - the challenge this round, or null on first round.<DD><CODE>username</CODE> - name of user<DD><CODE>password</CODE> - for username
229<DT><B>Returns:</B><DD>response</DL>
230</DD>
231</DL>
232<!-- ========= END OF CLASS DATA ========= -->
233<HR>
234
235
236<!-- ======= START OF BOTTOM NAVBAR ====== -->
237<A NAME="navbar_bottom"><!-- --></A>
238<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
239<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
240<TR>
241<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
242<A NAME="navbar_bottom_firstrow"><!-- --></A>
243<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
244  <TR ALIGN="center" VALIGN="top">
245  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
246  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
247  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
248  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
249  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
250  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
251  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
252  </TR>
253</TABLE>
254</TD>
255<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
256</EM>
257</TD>
258</TR>
259
260<TR>
261<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
262&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/ExceptionHandler.html" title="interface in com.rabbitmq.client.impl"><B>PREV CLASS</B></A>&nbsp;
263&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD>
264<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
265  <A HREF="../../../../index.html?com/rabbitmq/client/impl/ExternalMechanism.html" target="_top"><B>FRAMES</B></A>  &nbsp;
266&nbsp;<A HREF="ExternalMechanism.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
267&nbsp;<SCRIPT type="text/javascript">
268  <!--
269  if(window==top) {
270    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
271  }
272  //-->
273</SCRIPT>
274<NOSCRIPT>
275  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
276</NOSCRIPT>
277
278
279</FONT></TD>
280</TR>
281<TR>
282<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
283  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
284<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
285DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
286</TR>
287</TABLE>
288<A NAME="skip-navbar_bottom"></A>
289<!-- ======== END OF BOTTOM NAVBAR ======= -->
290
291<HR>
292
293</BODY>
294</HTML>
Note: See TracBrowser for help on using the repository browser.