diff options
Diffstat (limited to 'id.server/doc/moa_id/api-doc/at/gv/egovernment/moa/id/auth/AuthenticationServer.html')
| -rw-r--r-- | id.server/doc/moa_id/api-doc/at/gv/egovernment/moa/id/auth/AuthenticationServer.html | 631 |
1 files changed, 0 insertions, 631 deletions
diff --git a/id.server/doc/moa_id/api-doc/at/gv/egovernment/moa/id/auth/AuthenticationServer.html b/id.server/doc/moa_id/api-doc/at/gv/egovernment/moa/id/auth/AuthenticationServer.html deleted file mode 100644 index b5be8a054..000000000 --- a/id.server/doc/moa_id/api-doc/at/gv/egovernment/moa/id/auth/AuthenticationServer.html +++ /dev/null @@ -1,631 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.4.2_01) on Mon Mar 15 15:50:53 CET 2004 --> -<TITLE> -AuthenticationServer (MOA ID API) -</TITLE> - -<META NAME="keywords" CONTENT="at.gv.egovernment.moa.id.auth.AuthenticationServer class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="AuthenticationServer (MOA ID API)"; -} -</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/AuthenticationServer.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> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS - NEXT CLASS</FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> - <A HREF="AuthenticationServer.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> -at.gv.egovernment.moa.id.auth</FONT> -<BR> -Class AuthenticationServer</H2> -<PRE> -<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>at.gv.egovernment.moa.id.auth.AuthenticationServer</B> -</PRE> -<HR> -<DL> -<DT>public class <B>AuthenticationServer</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> - -<P> -API for MOA ID Authentication Service.<br> - <CODE>AuthenticationSession</CODE> is stored in a session store and retrieved - by giving the session ID. -<P> - -<P> -<HR> - -<P> -<!-- ======== NESTED CLASS SUMMARY ======== --> - - -<!-- =========== FIELD SUMMARY =========== --> - - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TD COLSPAN=2><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#AuthenticationServer()">AuthenticationServer</A></B>()</CODE> - -<BR> - Constructor for AuthenticationServer.</TD> -</TR> -</TABLE> - -<!-- ========== 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> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#cleanup()">cleanup</A></B>()</CODE> - -<BR> - Cleans up expired session and authentication data stores.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#debugOutputXMLFile(java.lang.String, org.w3c.dom.Element)">debugOutputXMLFile</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filename, - org.w3c.dom.Element rootElem)</CODE> - -<BR> - Writes an XML structure to file for debugging purposes, encoding UTF-8.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#debugOutputXMLFile(java.lang.String, java.lang.String)">debugOutputXMLFile</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filename, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> xmlString)</CODE> - -<BR> - Writes an XML structure to file for debugging purposes, encoding UTF-8.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../../../at/gv/egovernment/moa/id/data/AuthenticationData.html" title="class in at.gv.egovernment.moa.id.data">AuthenticationData</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#getAuthenticationData(java.lang.String)">getAuthenticationData</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> samlArtifact)</CODE> - -<BR> - Retrieves <code>AuthenticationData</code> indexed by the SAML artifact. - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html" title="class in at.gv.egovernment.moa.id.auth">AuthenticationServer</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#getInstance()">getInstance</A></B>()</CODE> - -<BR> - Returns the single instance of <code>AuthenticationServer</code>.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static AuthenticationSession</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#getSession(java.lang.String)">getSession</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id)</CODE> - -<BR> - Retrieves a session from the session store.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#selectBKU(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">selectBKU</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> authURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> oaURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> bkuSelectionTemplateURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> templateURL)</CODE> - -<BR> - Processes request to select a BKU. - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#setSecondsAuthDataTimeOut(long)">setSecondsAuthDataTimeOut</A></B>(long seconds)</CODE> - -<BR> - Sets the authDataTimeOut.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#setSecondsSessionTimeOut(long)">setSecondsSessionTimeOut</A></B>(long seconds)</CODE> - -<BR> - Sets the sessionTimeOut.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#startAuthentication(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">startAuthentication</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> authURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> oaURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> templateURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> bkuURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID)</CODE> - -<BR> - Processes the beginning of an authentication session. - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#verifyAuthenticationBlock(java.lang.String, java.lang.String)">verifyAuthenticationBlock</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> xmlCreateXMLSignatureReadResponse)</CODE> - -<BR> - Processes a <code><CreateXMLSignatureResponse></code> sent by the - security layer implementation.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html#verifyIdentityLink(java.lang.String, java.lang.String)">verifyIdentityLink</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> xmlInfoboxReadResponse)</CODE> - -<BR> - Processes an <code><InfoboxReadResponse></code> sent by the - security layer implementation.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ============ FIELD DETAIL =========== --> - - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TD COLSPAN=1><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TD> -</TR> -</TABLE> - -<A NAME="AuthenticationServer()"><!-- --></A><H3> -AuthenticationServer</H3> -<PRE> -public <B>AuthenticationServer</B>()</PRE> -<DL> -<DD>Constructor for AuthenticationServer. -<P> -</DL> - -<!-- ============ 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="getInstance()"><!-- --></A><H3> -getInstance</H3> -<PRE> -public static <A HREF="../../../../../../at/gv/egovernment/moa/id/auth/AuthenticationServer.html" title="class in at.gv.egovernment.moa.id.auth">AuthenticationServer</A> <B>getInstance</B>()</PRE> -<DL> -<DD>Returns the single instance of <code>AuthenticationServer</code>. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the single instance of <code>AuthenticationServer</code></DL> -</DD> -</DL> -<HR> - -<A NAME="selectBKU(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> -selectBKU</H3> -<PRE> -public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>selectBKU</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> authURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> oaURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> bkuSelectionTemplateURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> templateURL) - throws WrongParametersException, - <A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A>, - ConfigurationException, - BuildException</PRE> -<DL> -<DD>Processes request to select a BKU. - <br/>Processing depends on value of <CODE>AuthConfigurationProvider#getBKUSelectionType</CODE>. - <br/>For <code>bkuSelectionType==HTMLComplete</code>, a <code>returnURI</code> for the - "BKU Auswahl" service is returned. - <br/>For <code>bkuSelectionType==HTMLSelect</code>, an HTML form for BKU selection is returned. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>authURL</CODE> - base URL of MOA-ID Auth component<DD><CODE>target</CODE> - "Geschäftsbereich"<DD><CODE>oaURL</CODE> - online application URL requested<DD><CODE>bkuSelectionTemplateURL</CODE> - template for BKU selection form to be used - in case of <code>HTMLSelect</code>; may be null<DD><CODE>templateURL</CODE> - URL providing an HTML template for the HTML form to be used - for call <code>startAuthentication</code> -<DT><B>Returns:</B><DD>for <code>bkuSelectionType==HTMLComplete</code>, the <code>returnURI</code> for the - "BKU Auswahl" service; - for <code>bkuSelectionType==HTMLSelect</code>, an HTML form for BKU selection -<DT><B>Throws:</B> -<DD><CODE>WrongParametersException</CODE> - upon missing parameters -<DD><CODE><A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></CODE> - when the configured BKU selection service cannot be reached, - and when the given bkuSelectionTemplateURL cannot be reached -<DD><CODE>ConfigurationException</CODE> - on missing configuration data -<DD><CODE>BuildException</CODE> - while building the HTML form</DL> -</DD> -</DL> -<HR> - -<A NAME="startAuthentication(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> -startAuthentication</H3> -<PRE> -public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>startAuthentication</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> authURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> oaURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> templateURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> bkuURL, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID) - throws WrongParametersException, - <A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A>, - ConfigurationException, - BuildException</PRE> -<DL> -<DD>Processes the beginning of an authentication session. - <ul> - <li>Starts an authentication session</li> - <li>Creates an <code><InfoboxReadRequest></code></li> - <li>Creates an HTML form for querying the identity link from the - security layer implementation. - <br>Form parameters include - <ul> - <li>the <code><InfoboxReadRequest></code></li> - <li>the data URL where the security layer implementation sends it response to</li> - </ul> - </ul> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>authURL</CODE> - URL of the servlet to be used as data URL<DD><CODE>target</CODE> - "Geschäftsbereich" of the online application requested<DD><CODE>oaURL</CODE> - online application URL requested<DD><CODE>bkuURL</CODE> - URL of the "Bürgerkartenumgebung" to be used; - may be <code>null</code>; in this case, the default location will be used<DD><CODE>templateURL</CODE> - URL providing an HTML template for the HTML form generated -<DT><B>Returns:</B><DD>HTML form -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></CODE> -<DD><CODE>WrongParametersException</CODE> -<DD><CODE>ConfigurationException</CODE> -<DD><CODE>BuildException</CODE><DT><B>See Also:</B><DD><CODE>GetIdentityLinkFormBuilder</CODE>, -<CODE>InfoboxReadRequestBuilder</CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="verifyIdentityLink(java.lang.String, java.lang.String)"><!-- --></A><H3> -verifyIdentityLink</H3> -<PRE> -public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>verifyIdentityLink</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> xmlInfoboxReadResponse) - throws <A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A>, - ParseException, - ConfigurationException, - ValidateException, - ServiceException</PRE> -<DL> -<DD>Processes an <code><InfoboxReadResponse></code> sent by the - security layer implementation.<br> - <ul> - <li>Validates given <code><InfoboxReadResponse></code></li> - <li>Parses identity link enclosed in <code><InfoboxReadResponse></code></li> - <li>Verifies identity link by calling the MOA SP component</li> - <li>Checks certificate authority of identity link</li> - <li>Stores identity link in the session</li> - <li>Creates an authentication block to be signed by the user</li> - <li>Creates and returns a <code><CreateXMLSignatureRequest></code> - containg the authentication block, meant to be returned to the - security layer implementation</li> - </ul> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>sessionID</CODE> - ID of associated authentication session data<DD><CODE>xmlInfoboxReadResponse</CODE> - String representation of the - <code><InfoboxReadResponse></code> -<DT><B>Returns:</B><DD>String representation of the <code><CreateXMLSignatureRequest></code> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></CODE> -<DD><CODE>ParseException</CODE> -<DD><CODE>ConfigurationException</CODE> -<DD><CODE>ValidateException</CODE> -<DD><CODE>ServiceException</CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="verifyAuthenticationBlock(java.lang.String, java.lang.String)"><!-- --></A><H3> -verifyAuthenticationBlock</H3> -<PRE> -public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>verifyAuthenticationBlock</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> xmlCreateXMLSignatureReadResponse) - throws <A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A>, - BuildException, - ParseException, - ConfigurationException, - ServiceException, - ValidateException</PRE> -<DL> -<DD>Processes a <code><CreateXMLSignatureResponse></code> sent by the - security layer implementation.<br> - <ul> - <li>Validates given <code><CreateXMLSignatureResponse></code></li> - <li>Parses <code><CreateXMLSignatureResponse></code> for error codes</li> - <li>Parses authentication block enclosed in - <code><CreateXMLSignatureResponse></code></li> - <li>Verifies authentication block by calling the MOA SP component</li> - <li>Creates authentication data</li> - <li>Creates a corresponding SAML artifact</li> - <li>Stores authentication data in the authentication data store - indexed by the SAML artifact</li> - <li>Deletes authentication session</li> - <li>Returns the SAML artifact, encoded BASE64</li> - </ul> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>sessionID</CODE> - session ID of the running authentication session<DD><CODE>xmlCreateXMLSignatureReadResponse</CODE> - String representation of the - <code><CreateXMLSignatureResponse></code> -<DT><B>Returns:</B><DD>SAML artifact needed for retrieving authentication data, encoded BASE64 -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></CODE> -<DD><CODE>BuildException</CODE> -<DD><CODE>ParseException</CODE> -<DD><CODE>ConfigurationException</CODE> -<DD><CODE>ServiceException</CODE> -<DD><CODE>ValidateException</CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getAuthenticationData(java.lang.String)"><!-- --></A><H3> -getAuthenticationData</H3> -<PRE> -public <A HREF="../../../../../../at/gv/egovernment/moa/id/data/AuthenticationData.html" title="class in at.gv.egovernment.moa.id.data">AuthenticationData</A> <B>getAuthenticationData</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> samlArtifact) - throws <A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></PRE> -<DL> -<DD>Retrieves <code>AuthenticationData</code> indexed by the SAML artifact. - The <code>AuthenticationData</code> is deleted from the store upon end of this call. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD><code>AuthenticationData</code> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getSession(java.lang.String)"><!-- --></A><H3> -getSession</H3> -<PRE> -public static AuthenticationSession <B>getSession</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id) - throws <A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></PRE> -<DL> -<DD>Retrieves a session from the session store. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - session ID -<DT><B>Returns:</B><DD><code>AuthenticationSession</code> stored with given session ID, - <code>null</code> if session ID unknown -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../../at/gv/egovernment/moa/id/AuthenticationException.html" title="class in at.gv.egovernment.moa.id">AuthenticationException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="cleanup()"><!-- --></A><H3> -cleanup</H3> -<PRE> -public void <B>cleanup</B>()</PRE> -<DL> -<DD>Cleans up expired session and authentication data stores. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setSecondsSessionTimeOut(long)"><!-- --></A><H3> -setSecondsSessionTimeOut</H3> -<PRE> -public void <B>setSecondsSessionTimeOut</B>(long seconds)</PRE> -<DL> -<DD>Sets the sessionTimeOut. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setSecondsAuthDataTimeOut(long)"><!-- --></A><H3> -setSecondsAuthDataTimeOut</H3> -<PRE> -public void <B>setSecondsAuthDataTimeOut</B>(long seconds)</PRE> -<DL> -<DD>Sets the authDataTimeOut. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="debugOutputXMLFile(java.lang.String, org.w3c.dom.Element)"><!-- --></A><H3> -debugOutputXMLFile</H3> -<PRE> -public static void <B>debugOutputXMLFile</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filename, - org.w3c.dom.Element rootElem)</PRE> -<DL> -<DD>Writes an XML structure to file for debugging purposes, encoding UTF-8. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>filename</CODE> - file name<DD><CODE>rootElem</CODE> - root element in DOM tree</DL> -</DD> -</DL> -<HR> - -<A NAME="debugOutputXMLFile(java.lang.String, java.lang.String)"><!-- --></A><H3> -debugOutputXMLFile</H3> -<PRE> -public static void <B>debugOutputXMLFile</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filename, - <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> xmlString)</PRE> -<DL> -<DD>Writes an XML structure to file for debugging purposes, encoding UTF-8. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>filename</CODE> - file name<DD><CODE>xmlString</CODE> - XML string</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/AuthenticationServer.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> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS - NEXT CLASS</FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> - <A HREF="AuthenticationServer.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> - -</BODY> -</HTML> |