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

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

new release version
File size: 9.7 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:10 GMT 2012 -->
6<TITLE>
7SaslMechanism
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="SaslMechanism";
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/SaslConfig.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownListener.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/SaslMechanism.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="SaslMechanism.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>
92Interface SaslMechanism</H2>
93<DL>
94<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/rabbitmq/client/impl/CRDemoMechanism.html" title="class in com.rabbitmq.client.impl">CRDemoMechanism</A>, <A HREF="../../../com/rabbitmq/client/impl/ExternalMechanism.html" title="class in com.rabbitmq.client.impl">ExternalMechanism</A>, <A HREF="../../../com/rabbitmq/client/impl/PlainMechanism.html" title="class in com.rabbitmq.client.impl">PlainMechanism</A></DD>
95</DL>
96<HR>
97<DL>
98<DT><PRE>public interface <B>SaslMechanism</B></DL>
99</PRE>
100
101<P>
102Our own view of a SASL authentication mechanism, introduced to remove a
103 dependency on javax.security.sasl.
104<P>
105
106<P>
107<HR>
108
109<P>
110
111<!-- ========== METHOD SUMMARY =========== -->
112
113<A NAME="method_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Method Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../com/rabbitmq/client/SaslMechanism.html#getName()">getName</A></B>()</CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of this mechanism (e.g.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/LongString.html" title="interface in com.rabbitmq.client">LongString</A></CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../com/rabbitmq/client/SaslMechanism.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,
131                java.lang.String&nbsp;username,
132                java.lang.String&nbsp;password)</CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handle one round of challenge-response</TD>
136</TR>
137</TABLE>
138&nbsp;
139<P>
140
141<!-- ============ METHOD DETAIL ========== -->
142
143<A NAME="method_detail"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
147<B>Method Detail</B></FONT></TH>
148</TR>
149</TABLE>
150
151<A NAME="getName()"><!-- --></A><H3>
152getName</H3>
153<PRE>
154java.lang.String <B>getName</B>()</PRE>
155<DL>
156<DD>The name of this mechanism (e.g. PLAIN)
157<P>
158<DD><DL>
159
160<DT><B>Returns:</B><DD>the name</DL>
161</DD>
162</DL>
163<HR>
164
165<A NAME="handleChallenge(com.rabbitmq.client.LongString, java.lang.String, java.lang.String)"><!-- --></A><H3>
166handleChallenge</H3>
167<PRE>
168<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,
169                           java.lang.String&nbsp;username,
170                           java.lang.String&nbsp;password)</PRE>
171<DL>
172<DD>Handle one round of challenge-response
173<P>
174<DD><DL>
175<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
176<DT><B>Returns:</B><DD>response
177<DT><B>Throws:</B>
178<DD><CODE>java.io.IOException</CODE></DL>
179</DD>
180</DL>
181<!-- ========= END OF CLASS DATA ========= -->
182<HR>
183
184
185<!-- ======= START OF BOTTOM NAVBAR ====== -->
186<A NAME="navbar_bottom"><!-- --></A>
187<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
188<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
189<TR>
190<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
191<A NAME="navbar_bottom_firstrow"><!-- --></A>
192<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
193  <TR ALIGN="center" VALIGN="top">
194  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
195  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
196  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
197  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
198  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
199  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
200  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
201  </TR>
202</TABLE>
203</TD>
204<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
205</EM>
206</TD>
207</TR>
208
209<TR>
210<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
211&nbsp;<A HREF="../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
212&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
213<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
214  <A HREF="../../../index.html?com/rabbitmq/client/SaslMechanism.html" target="_top"><B>FRAMES</B></A>  &nbsp;
215&nbsp;<A HREF="SaslMechanism.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
216&nbsp;<SCRIPT type="text/javascript">
217  <!--
218  if(window==top) {
219    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
220  }
221  //-->
222</SCRIPT>
223<NOSCRIPT>
224  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
225</NOSCRIPT>
226
227
228</FONT></TD>
229</TR>
230<TR>
231<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
232  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
233<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
234DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
235</TR>
236</TABLE>
237<A NAME="skip-navbar_bottom"></A>
238<!-- ======== END OF BOTTOM NAVBAR ======= -->
239
240<HR>
241
242</BODY>
243</HTML>
Note: See TracBrowser for help on using the repository browser.