1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:01 IST 2011 -->
\r
10 <META NAME="keywords" CONTENT="com.pras.auth.Authenticator interface">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="Authenticator";
\r
25 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../com/pras/auth/Account.html" title="class in com.pras.auth"><B>PREV CLASS</B></A>
\r
56 <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>
\r
59 <A HREF="Authenticator.html" target="_top"><B>NO FRAMES</B></A>
\r
60 <SCRIPT type="text/javascript">
\r
63 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
68 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
76 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
81 <A NAME="skip-navbar_top"></A>
\r
82 <!-- ========= END OF TOP NAVBAR ========= -->
\r
85 <!-- ======== START OF CLASS DATA ======== -->
\r
88 com.pras.auth</FONT>
\r
90 Interface Authenticator</H2>
\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
96 <DT><PRE>public interface <B>Authenticator</B></DL>
\r
104 <!-- ========== METHOD SUMMARY =========== -->
\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
112 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
113 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
114 <CODE> 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 service)</CODE>
\r
118 Do the authentication and read Auth_Token from Server.</TD>
\r
124 <!-- ============ METHOD DETAIL ========== -->
\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
134 <A NAME="getAuthToken(java.lang.String)"><!-- --></A><H3>
\r
137 java.lang.String <B>getAuthToken</B>(java.lang.String service)</PRE>
\r
139 <DD>Do the authentication and read Auth_Token from Server. The implementor class
140 will provide Account (Gmail) and Service details
\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
147 <!-- ========= END OF CLASS DATA ========= -->
\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
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> </TD>
\r
161 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
162 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
163 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Authenticator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
164 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
165 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
166 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
167 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
171 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
177 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
178 <A HREF="../../../com/pras/auth/Account.html" title="class in com.pras.auth"><B>PREV CLASS</B></A>
\r
179 <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>
\r
182 <A HREF="Authenticator.html" target="_top"><B>NO FRAMES</B></A>
\r
183 <SCRIPT type="text/javascript">
\r
186 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
191 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
198 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
199 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
200 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
201 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
204 <A NAME="skip-navbar_bottom"></A>
\r
205 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r