📄 authenticator.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><TITLE>Authenticator (Project JXTA J2SE)</TITLE><META NAME="keywords" CONTENT="net.jxta.membership.Authenticator interface"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="Authenticator (Project JXTA J2SE)";}</SCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=3 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="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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><a href='http://www.jxta.org' target='_blank'>Project JXTA</a></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../net/jxta/membership/InteractiveAuthenticator.html" title="interface in net.jxta.membership"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> <A HREF="Authenticator.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="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#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">net.jxta.membership</FONT><BR>Interface Authenticator</H2><DL><DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../net/jxta/membership/InteractiveAuthenticator.html" title="interface in net.jxta.membership">InteractiveAuthenticator</A></DD></DL><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../net/jxta/impl/membership/pse/DialogAuthenticator.html" title="class in net.jxta.impl.membership.pse">DialogAuthenticator</A>, <A HREF="../../../net/jxta/impl/membership/NullMembershipService.NullAuthenticator.html" title="class in net.jxta.impl.membership">NullMembershipService.NullAuthenticator</A>, <A HREF="../../../net/jxta/impl/membership/PasswdMembershipService.PasswdAuthenticator.html" title="class in net.jxta.impl.membership">PasswdMembershipService.PasswdAuthenticator</A>, <A HREF="../../../net/jxta/impl/membership/pse/StringAuthenticator.html" title="class in net.jxta.impl.membership.pse">StringAuthenticator</A></DD></DL><HR><DL><DT>public interface <B>Authenticator</B></DL><P>An Authenticator is returned by the <A HREF="../../../net/jxta/membership/MembershipService.html#apply(net.jxta.credential.AuthenticationCredential)">apply()</A> to the Membership Service of a peergroup. The Membership When the authenticator has been completed it is returned to the Membership Service via the "Join" operation. <p/>The mechanism for completing the authentication object is unique for each authentication method. (That's the whole point of writing a Membership Service). The only common operation is <code>isReadyForJoin</code>, which provides information as to whether you have completed the authenticator correctly.<P><P><DL><DT><B>See Also:</B><DD><A HREF="../../../net/jxta/membership/MembershipService.html" title="interface in net.jxta.membership"><CODE>MembershipService</CODE></A>, <A HREF="../../../net/jxta/credential/Credential.html" title="interface in net.jxta.credential"><CODE>Credential</CODE></A>, <A HREF="../../../net/jxta/credential/AuthenticationCredential.html" title="class in net.jxta.credential"><CODE>AuthenticationCredential</CODE></A></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><!-- ======== CONSTRUCTOR SUMMARY ======== --><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../net/jxta/credential/AuthenticationCredential.html" title="class in net.jxta.credential">AuthenticationCredential</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/jxta/membership/Authenticator.html#getAuthenticationCredential()">getAuthenticationCredential</A></B>()</CODE><BR> Return the Authentication Credential associated with this authenticator, if any.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/jxta/membership/Authenticator.html#getMethodName()">getMethodName</A></B>()</CODE><BR> Returns the name of this authentication method. </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../net/jxta/membership/MembershipService.html" title="interface in net.jxta.membership">MembershipService</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/jxta/membership/Authenticator.html#getSourceService()">getSourceService</A></B>()</CODE><BR> Returns the service which generated this authenticator. </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/jxta/membership/Authenticator.html#isReadyForJoin()">isReadyForJoin</A></B>()</CODE><BR> Returns true if this Authenticator has been satisfied and is ready for submission to <A HREF="../../../net/jxta/membership/MembershipService.html#join(net.jxta.membership.Authenticator)"><CODE>MembershipService.join(Authenticator)</CODE></A>. </TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><!-- ========= CONSTRUCTOR DETAIL ======== --><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Method Detail</B></FONT></TD></TR></TABLE><A NAME="getMethodName()"><!-- --></A><H3>getMethodName</H3><PRE>public java.lang.String <B>getMethodName</B>()</PRE><DL><DD>Returns the name of this authentication method. This should be the same name which was used in the Authentication credential.<P><DD><DL><DT><B>Returns:</B><DD>String containing the name of this authentication method.</DL></DD></DL><HR><A NAME="getAuthenticationCredential()"><!-- --></A><H3>getAuthenticationCredential</H3><PRE>public <A HREF="../../../net/jxta/credential/AuthenticationCredential.html" title="class in net.jxta.credential">AuthenticationCredential</A> <B>getAuthenticationCredential</B>()</PRE><DL><DD>Return the Authentication Credential associated with this authenticator, if any.<P><DD><DL><DT><B>Returns:</B><DD>the AutheticationCredential which was provided to the <A HREF="../../../net/jxta/membership/MembershipService.html#apply(net.jxta.credential.AuthenticationCredential)"><CODE>MembershipService.apply(AuthenticationCredential)</CODE></A>.</DL></DD></DL><HR><A NAME="getSourceService()"><!-- --></A><H3>getSourceService</H3><PRE>public <A HREF="../../../net/jxta/membership/MembershipService.html" title="interface in net.jxta.membership">MembershipService</A> <B>getSourceService</B>()</PRE><DL><DD>Returns the service which generated this authenticator. This is the service which provided this authenticator and the service which will accept this authenticator when the authenticator is completed.<P><DD><DL><DT><B>Returns:</B><DD>the MembershipService service associated with this authenticator.</DL></DD></DL><HR><A NAME="isReadyForJoin()"><!-- --></A><H3>isReadyForJoin</H3><PRE>public boolean <B>isReadyForJoin</B>()</PRE><DL><DD>Returns true if this Authenticator has been satisfied and is ready for submission to <A HREF="../../../net/jxta/membership/MembershipService.html#join(net.jxta.membership.Authenticator)"><CODE>MembershipService.join(Authenticator)</CODE></A>. Some authenticators may behave asynchronously and this method can be used to determine if the authentication process has completed. <p/>This method provides no distinction between incomplete authentication and failed authentication.<P><DD><DL><DT><B>Returns:</B><DD>true if the authenticator object is complete and ready for submitting to the Membership Service service for <A HREF="../../../net/jxta/membership/MembershipService.html#join(net.jxta.membership.Authenticator)"><CODE>MembershipService.join(Authenticator)</CODE></A>, otherwise false.<DT><B>See Also:</B><DD><A HREF="../../../net/jxta/membership/MembershipService.html#join(net.jxta.membership.Authenticator)"><CODE>MembershipService.join(Authenticator)</CODE></A></DL></DD></DL><!-- ========= END OF CLASS DATA ========= --><HR><!-- ======= START OF BOTTOM NAVBAR ====== --><A NAME="navbar_bottom"><!-- --></A><A HREF="#skip-navbar_bottom" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=3 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="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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>JXTA J2SE</EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../net/jxta/membership/InteractiveAuthenticator.html" title="interface in net.jxta.membership"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> <A HREF="Authenticator.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="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_bottom"></A><!-- ======== END OF BOTTOM NAVBAR ======= --><HR></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -