📄 credential.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>Credential (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.wps.portletservice.credentialvault.credentials.Credential class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="Credential (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/BinaryPassiveCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials"><B>PREV CLASS</B></A> <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/HttpBasicAuthCredential.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="Credential.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 Credential</H2><PRE>java.lang.Object <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>com.ibm.wps.portletservice.credentialvault.credentials.Credential</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/Credential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">Credential</A>, java.io.Serializable</DD></DL><DL><DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/ActiveCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">ActiveCredential</A>, <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/PassiveCredential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">PassiveCredential</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 abstract class <B>Credential</B><DT>extends java.lang.Object<DT>implements java.io.Serializable, <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/Credential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">Credential</A></DL><P>Abstract base class for all credential classes. As such it is the WP <CODE>Credential</CODE> "interface". The different terms need to be distinguished when talking of (active) credentials: <ol> <li>A <i>Credential Type</i> is an implementation of an abstract credential class that has authentication methods specialized to perform a certain kind of authentication (e.g. form-based web authentication).</br> Credential Types will be defined and delivered by the portal framework. They are registered in a credential registry and can be retrieved through a method on the <code>CredentialVaultService</code>.</li> <li>A <i>Credential Instance</i> is an Credential Type that has been configured to work with one specific backend (application), or simply speaking: <code>Credential Instance = Credential Type + configuration data</code> (e.g. the mycompany-webmail-credential is a form-based web authentication credential plus information about the postURL, userid attribute name and password attribute name).</li> <li>A <i>Concrete Credential Object</i> is a Java object of a Credential Instance of the kind that is passed between vault (service) and portlet. This credential object is user specific as it carries the user secret with it.</li> </ol> <b>Note</b>: All concrete subclasses <i>must</i> provide a no-argument constructor. The credentials are initialized by the <code>init</code> method.<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.Credential">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>protected static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#LOGGER_NAME">LOGGER_NAME</A></B></CODE><BR> <B>Deprecated.</B> Name of the logger that all WP credentials should use for logging.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected com.ibm.wps.sso.credentialvault.secrets.CredentialSecret</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#secret">secret</A></B></CODE><BR> <B>Deprecated.</B> </TD></TR></TABLE> <A NAME="fields_inherited_from_class_com.ibm.portal.portlet.service.credentialvault.credentials.Credential"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Fields inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.<A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/Credential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">Credential</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/Credential.html#KEY_CREDENTIAL_SECRET">KEY_CREDENTIAL_SECRET</A></CODE></TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_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>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#Credential()">Credential</A></B>()</CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#Credential(java.util.Map)">Credential</A></B>(java.util.Map config)</CODE><BR> <B>Deprecated.</B> Creates and initializes a new Credential Object.</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"><TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#checkInitialized()">checkInitialized</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> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#getSecretType()">getSecretType</A></B>()</CODE><BR> <B>Deprecated.</B> Returns the credential's Secret Type in terms of the constants declared in <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/CredentialVaultService.html" title="interface in com.ibm.wps.portletservice.credentialvault"><CODE>CredentialVaultService</CODE></A></br> Should be overwritten by any child class that "overwrites" the secret attribute.</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="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#init(java.util.Map)">init</A></B>(java.util.Map config)</CODE><BR> <B>Deprecated.</B> Initializes the credential with the specified configuration.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html#isActive()">isActive</A></B>()</CODE><BR>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -