jars/gss-lib-2.2/javadoc/com/pras/auth/Authenticator.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:01 IST 2011 -->\r
   6 <TITLE>\r
   7 Authenticator\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.pras.auth.Authenticator interface">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     parent.document.title="Authenticator";\r
  18 }\r
  19 </SCRIPT>\r
  20 <NOSCRIPT>\r
  21 </NOSCRIPT>\r
  22 \r
  23 </HEAD>\r
  24 \r
  25 <BODY BGCOLOR="white" onload="windowTitle();">\r
  26 \r
  27 \r
  28 <!-- ========= START OF TOP NAVBAR ======= -->\r
  29 <A NAME="navbar_top"><!-- --></A>\r
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  32 <TR>\r
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  34 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  36   <TR ALIGN="center" VALIGN="top">\r
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  45   </TR>\r
  46 </TABLE>\r
  47 </TD>\r
  48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  49 </EM>\r
  50 </TD>\r
  51 </TR>\r
  52 \r
  53 <TR>\r
  54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  55 &nbsp;<A HREF="../../../com/pras/auth/Account.html" title="class in com.pras.auth"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../../com/pras/auth/BasicAuthenticatorImpl.html" title="class in com.pras.auth"><B>NEXT CLASS</B></A></FONT></TD>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58   <A HREF="../../../index.html?com/pras/auth/Authenticator.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="Authenticator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  60 &nbsp;<SCRIPT type="text/javascript">\r
  61   <!--\r
  62   if(window==top) {\r
  63     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  64   }\r
  65   //-->\r
  66 </SCRIPT>\r
  67 <NOSCRIPT>\r
  68   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  69 </NOSCRIPT>\r
  70 \r
  71 \r
  72 </FONT></TD>\r
  73 </TR>\r
  74 <TR>\r
  75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  78 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  79 </TR>\r
  80 </TABLE>\r
  81 <A NAME="skip-navbar_top"></A>\r
  82 <!-- ========= END OF TOP NAVBAR ========= -->\r
  83 \r
  84 <HR>\r
  85 <!-- ======== START OF CLASS DATA ======== -->\r
  86 <H2>\r
  87 <FONT SIZE="-1">\r
  88 com.pras.auth</FONT>\r
  89 <BR>\r
  90 Interface Authenticator</H2>\r
  91 <DL>\r
  92 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/pras/auth/BasicAuthenticatorImpl.html" title="class in com.pras.auth">BasicAuthenticatorImpl</A></DD>\r
  93 </DL>\r
  94 <HR>\r
  95 <DL>\r
  96 <DT><PRE>public interface <B>Authenticator</B></DL>\r
  97 </PRE>\r
  98 \r
  99 <P>\r
 100 <HR>\r
 101 \r
 102 <P>\r
 103 \r
 104 <!-- ========== METHOD SUMMARY =========== -->\r
 105 \r
 106 <A NAME="method_summary"><!-- --></A>\r
 107 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 108 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 109 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 110 <B>Method Summary</B></FONT></TH>\r
 111 </TR>\r
 112 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 113 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 114 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 115 <TD><CODE><B><A HREF="../../../com/pras/auth/Authenticator.html#getAuthToken(java.lang.String)">getAuthToken</A></B>(java.lang.String&nbsp;service)</CODE>\r
 116 \r
 117 <BR>\r
 118 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do the authentication and read Auth_Token from Server.</TD>\r
 119 </TR>\r
 120 </TABLE>\r
 121 &nbsp;\r
 122 <P>\r
 123 \r
 124 <!-- ============ METHOD DETAIL ========== -->\r
 125 \r
 126 <A NAME="method_detail"><!-- --></A>\r
 127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 129 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 130 <B>Method Detail</B></FONT></TH>\r
 131 </TR>\r
 132 </TABLE>\r
 133 \r
 134 <A NAME="getAuthToken(java.lang.String)"><!-- --></A><H3>\r
 135 getAuthToken</H3>\r
 136 <PRE>\r
 137 java.lang.String <B>getAuthToken</B>(java.lang.String&nbsp;service)</PRE>\r
 138 <DL>\r
 139 <DD>Do the authentication and read Auth_Token from Server. The implementor class
 140  will provide Account (Gmail) and Service details\r
 141 <P>\r
 142 <DD><DL>\r
 143 <DT><B>Parameters:</B><DD><CODE>service</CODE> - Name of the Service for which Authentication Token is required e.g. "wise" for SpreadSheet\r
 144 <DT><B>Returns:</B><DD></DL>\r
 145 </DD>\r
 146 </DL>\r
 147 <!-- ========= END OF CLASS DATA ========= -->\r
 148 <HR>\r
 149 \r
 150 \r
 151 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 152 <A NAME="navbar_bottom"><!-- --></A>\r
 153 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 154 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 155 <TR>\r
 156 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 157 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 158 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 159   <TR ALIGN="center" VALIGN="top">\r
 160   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 161   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 162   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 163   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 164   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 165   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 166   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 167   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 168   </TR>\r
 169 </TABLE>\r
 170 </TD>\r
 171 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 172 </EM>\r
 173 </TD>\r
 174 </TR>\r
 175 \r
 176 <TR>\r
 177 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 178 &nbsp;<A HREF="../../../com/pras/auth/Account.html" title="class in com.pras.auth"><B>PREV CLASS</B></A>&nbsp;\r
 179 &nbsp;<A HREF="../../../com/pras/auth/BasicAuthenticatorImpl.html" title="class in com.pras.auth"><B>NEXT CLASS</B></A></FONT></TD>\r
 180 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 181   <A HREF="../../../index.html?com/pras/auth/Authenticator.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 182 &nbsp;<A HREF="Authenticator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 183 &nbsp;<SCRIPT type="text/javascript">\r
 184   <!--\r
 185   if(window==top) {\r
 186     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 187   }\r
 188   //-->\r
 189 </SCRIPT>\r
 190 <NOSCRIPT>\r
 191   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 192 </NOSCRIPT>\r
 193 \r
 194 \r
 195 </FONT></TD>\r
 196 </TR>\r
 197 <TR>\r
 198 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 199   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 200 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 201 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 202 </TR>\r
 203 </TABLE>\r
 204 <A NAME="skip-navbar_bottom"></A>\r
 205 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 206 \r
 207 <HR>\r
 208 \r
 209 </BODY>\r
 210 </HTML>\r