httpformbasedauthcredential.html

门户开发

</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="KEY_USERID_ATTRIBUTE_NAME"><!-- --></A><H3>
KEY_USERID_ATTRIBUTE_NAME</H3>
<PRE>
public static final java.lang.String <B>KEY_USERID_ATTRIBUTE_NAME</B></PRE>
<DL>
<DD>The name under which the user id is posted (mandatory).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.credentials.HttpFormBasedAuthCredential.KEY_USERID_ATTRIBUTE_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="KEY_PASSWORD_ATTRIBUTE_NAME"><!-- --></A><H3>
KEY_PASSWORD_ATTRIBUTE_NAME</H3>
<PRE>
public static final java.lang.String <B>KEY_PASSWORD_ATTRIBUTE_NAME</B></PRE>
<DL>
<DD>The name under which the user password is posted (mandatory).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.credentials.HttpFormBasedAuthCredential.KEY_PASSWORD_ATTRIBUTE_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="KEY_LOGIN_URL"><!-- --></A><H3>
KEY_LOGIN_URL</H3>
<PRE>
public static final java.lang.String <B>KEY_LOGIN_URL</B></PRE>
<DL>
<DD>The url to which the login data is posted (mandatory).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.credentials.HttpFormBasedAuthCredential.KEY_LOGIN_URL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="KEY_LOGOUT_URL"><!-- --></A><H3>
KEY_LOGOUT_URL</H3>
<PRE>
public static final java.lang.String <B>KEY_LOGOUT_URL</B></PRE>
<DL>
<DD>The url to which an HTTP GET request is send in order to log out the user (mandatory).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.credentials.HttpFormBasedAuthCredential.KEY_LOGOUT_URL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="KEY_FORM_DATA"><!-- --></A><H3>
KEY_FORM_DATA</H3>
<PRE>
public static final java.lang.String <B>KEY_FORM_DATA</B></PRE>
<DL>
<DD>Specifies whether the authentication data are cookies [true] or URL rewriting [false] (mandatory).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.credentials.HttpFormBasedAuthCredential.KEY_FORM_DATA">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="KEY_USE_AUTH_COOKIES"><!-- --></A><H3>
KEY_USE_AUTH_COOKIES</H3>
<PRE>
public static final java.lang.String <B>KEY_USE_AUTH_COOKIES</B></PRE>
<DL>
<DD>Any additional <code>name=value</code>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.credentials.HttpFormBasedAuthCredential.KEY_USE_AUTH_COOKIES">Constant Field Values</A></DL>
</DL>

<!-- ========= 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="init(java.util.Map)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(java.util.Map&nbsp;config)
          throws <A HREF="../../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultException.html" title="class in com.ibm.portal.portlet.service.credentialvault">CredentialVaultException</A></PRE>
<DL>
<DD>Initializes a new Http Form Based Authentication Credential.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/UserPasswordCredential.html#init(java.util.Map)">init</A></CODE> in interface <CODE><A HREF="../../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/UserPasswordCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">UserPasswordCredential</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The configuration that is needed to initialize this credential:
           <ul>
             <li>KEY_CREDENTIAL_SECRET        UserPasswordCredentialSecret - the credential's secret (mandatory)</li>
             <li>KEY_USERID_ATTRIBUTE_NAME    String - the name under which the user id is posted (mandatory)</li>
             <li>KEY_PASSWORD_ATTRIBUTE_NAME  String - the name under which the user password is posted (mandatory)</li>
             <li>KEY_LOGIN_URL                String - the url to which the login data is posted (mandatory)</li>
             <li>KEY_LOGOUT_URL               String - the url to which an HTTP GET request is send in order to log out the user (mandatory)</li>
             <li>KEY_USE_AUTH_COOKIES         Boolean - specifies whether the authentication data are cookies [true] or URL rewriting [false] (mandatory)</li>
             <li>KEY_FORM_DATA                List - any additional <code>name=value</code> pairs that need to be posted with the login POST (optional)</li>
           </ul>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultException.html" title="class in com.ibm.portal.portlet.service.credentialvault">CredentialVaultException</A></CODE> - If any mandatory parameter is missing or has a wrong object type as value.</DL>
</DD>
</DL>
<HR>

<A NAME="login()"><!-- --></A><H3>
login</H3>
<PRE>
public java.net.HttpURLConnection <B>login</B>()
                                 throws java.io.IOException</PRE>
<DL>
<DD>Performs the HTTP form based login.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>HttpURLConnection
            The connection that was used for the login POST request.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the login failed or no cookie has been returned.</DL>
</DD>
</DL>
<HR>

<A NAME="logout()"><!-- --></A><H3>
logout</H3>
<PRE>
public java.net.HttpURLConnection <B>logout</B>()
                                  throws java.io.IOException</PRE>
<DL>
<DD>Performs the logout through an HTTP GET request to the logout Url.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>HttpURLConnection
            The connection that was used for the logou GET request.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the logout failed or credential status is not 'logged in'.</DL>
</DD>
</DL>
<HR>

<A NAME="getAuthenticatedConnection(java.lang.String)"><!-- --></A><H3>
getAuthenticatedConnection</H3>
<PRE>
public java.net.HttpURLConnection <B>getAuthenticatedConnection</B>(java.lang.String&nbsp;url)
                                                      throws java.io.IOException</PRE>
<DL>
<DD>Returns a new HttpURLConnection with added authentication data.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the target URL for the connection.
<DT><B>Returns:</B><DD>HttpURLConnection
            A new authenticated (and yet uncommitted) connection.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if anything unexpected happens.</DL>
</DD>
</DL>
<HR>

<A NAME="getAuthenticatedConnection(java.net.URL)"><!-- --></A><H3>
getAuthenticatedConnection</H3>
<PRE>
public java.net.HttpURLConnection <B>getAuthenticatedConnection</B>(java.net.URL&nbsp;url)
                                                      throws java.io.IOException</PRE>
<DL>
<DD>Returns a new HttpURLConnection with added authentication data.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the target URL for the connection. Note that it need not be opened yet.
           Note also that this method may only be called if cookies are used for authentication.
<DT><B>Returns:</B><DD>HttpURLConnection
            A new authenticated (and yet uncommitted) connection.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - thrown if anything unexpected happens.</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/HttpBasicAuthCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/JaasSubjectCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials"><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>  &nbsp;
&nbsp;<A HREF="HttpFormBasedAuthCredential.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>