📄 httpformbasedauthcredential.html
字号:
<!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) on Wed Jul 19 18:22:43 EDT 2006 --><TITLE>HttpFormBasedAuthCredential (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.wps.portletservice.credentialvault.credentials.HttpFormBasedAuthCredential class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="HttpFormBasedAuthCredential (IBM WebSphere Portal Version 6.0.0.0 API Docs)";}</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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</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="../../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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"> <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpBasicAuthCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials"><B>PREV CLASS</B></A> <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/JaasSubjectCredential.html" title="class in com.ibm.wps.portletservice.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> <A HREF="HttpFormBasedAuthCredential.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <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><A NAME="main"></A><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">com.ibm.wps.portletservice.credentialvault.credentials</FONT><BR>Class HttpFormBasedAuthCredential</H2><PRE>java.lang.Object <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">com.ibm.wps.portletservice.credentialvault.credentials.Credential</A> <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/ActiveCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential</A> <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/UserPasswordCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential</A> <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>com.ibm.wps.portletservice.credentialvault.credentials.HttpFormBasedAuthCredential</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/ActiveCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">ActiveCredential</A>, <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/Credential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">Credential</A>, <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/HttpFormBasedAuthCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">HttpFormBasedAuthCredential</A>, java.io.Serializable, <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/UserPasswordCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">UserPasswordCredential</A></DD></DL><HR><B>Deprecated.</B> <I>since 6.0. Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.</I><P><DL><DT>public class <B>HttpFormBasedAuthCredential</B><DT>extends <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/UserPasswordCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">UserPasswordCredential</A><DT>implements <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/HttpFormBasedAuthCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">HttpFormBasedAuthCredential</A></DL><P>Credential for authenticating at the back-end via Http Form Based authentication. To be used in following way: <ol> <li>Construct (initialize) the credential</li> <li>Call login method to authenticate at the back-end system</li> <li>Get an authenticated Http URL connection from the Credential</li> <li>Do business calls over the authenticated connection</li> <li>Finally call logout method to logout at the back-end system</li> </ol> Preconditions: <ul> <li>the configuration data passed to the constructor <i>must</i> define following values: KEY_USER_ID_ATTRIBUTE, KEY_PASSWORD_ATTRIBUTE, KEY_LOGIN_POST_URL, KEY_LOGOUT_GET_URL, KEY_FORM_DATA and KEY_USE_AUTH_COOKIES (in addition to the ones required by <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/UserPasswordCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials"><CODE>UserPasswordCredential</CODE></A>)</li> <li>loginPostUrl and logoutGetUrl must use HTTP</li> </ul> Assumptions: <ul> <li>The logout is performed through a HTTP GET request to the logout url</li> <li>If the Url uses SSL (https://) the JSSE has already been registered</li> <li>If the security information being returned on successful login is <i>not</i> a cookie but url parameters (i.e. URL rewriting is used), then it is assumed that the response to a successful login is an http redirect (the redirect URL can be found in the header field 'Location').</li> </ul><P><P><DL><DT><B>Since:</B></DT> <DD>WP 5.1.0.1</DD><DT><B>See Also:</B><DD><A HREF="../../../../../../serialized-form.html#com.ibm.wps.portletservice.credentialvault.credentials.HttpFormBasedAuthCredential">Serialized Form</A></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><A NAME="field_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"><B>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpFormBasedAuthCredential.html#KEY_FORM_DATA">KEY_FORM_DATA</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpFormBasedAuthCredential.html#KEY_LOGIN_URL">KEY_LOGIN_URL</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpFormBasedAuthCredential.html#KEY_LOGOUT_URL">KEY_LOGOUT_URL</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpFormBasedAuthCredential.html#KEY_PASSWORD_ATTRIBUTE_NAME">KEY_PASSWORD_ATTRIBUTE_NAME</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpFormBasedAuthCredential.html#KEY_USE_AUTH_COOKIES">KEY_USE_AUTH_COOKIES</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpFormBasedAuthCredential.html#KEY_USERID_ATTRIBUTE_NAME">KEY_USERID_ATTRIBUTE_NAME</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR></TABLE> <A NAME="fields_inherited_from_class_com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Fields inherited from class com.ibm.wps.portletservice.credentialvault.credentials.<A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/UserPasswordCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">UserPasswordCredential</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -