📄 credentialvaultservice.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:41 EDT 2006 --><TITLE>CredentialVaultService (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.portal.portlet.service.credentialvault.CredentialVaultService interface"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="CredentialVaultService (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/portal/portlet/service/credentialvault/CredentialTypes.html" title="interface in com.ibm.portal.portlet.service.credentialvault"><B>PREV CLASS</B></A> <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/VaultSegmentConfig.html" title="interface in com.ibm.portal.portlet.service.credentialvault"><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="CredentialVaultService.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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.portal.portlet.service.credentialvault</FONT><BR>Interface CredentialVaultService</H2><DL><DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../com/ibm/portal/portlet/service/PortletService.html" title="interface in com.ibm.portal.portlet.service">PortletService</A></DD></DL><HR><DL><DT>public interface <B>CredentialVaultService</B><DT>extends <A HREF="../../../../../../com/ibm/portal/portlet/service/PortletService.html" title="interface in com.ibm.portal.portlet.service">PortletService</A></DL><P>Portlet Service for JSR compliant portlets to access the WebSphere Portal Credential Vault. The portlet service offers the following functionality: <ul> <li><b>Management of Credential Vault Slots. </b> Credential Vault Segments can be retrieved, and Vault Slots can be created and deleted.</li> <li><b>Management of Credential Secrets. </b> The service allows to set or retrieve credentials from the credential vault.</li> </ul> <p> Available <b>Secret Types </b> in the Credential Vault are definied as constants in this interface. Please note that not all types have to be available in the defined Vault Segments, depending on the utilized Vault Adapter implementation. Supported types per segment can be retrieved through <A HREF="../../../../../../com/ibm/wps/portletservice/credentialvault/VaultSegmentConfig.html#getSupportedSecretTypes()"><CODE>VaultSegmentConfig#getSupportedSecretTypes()</CODE></A>. </p> <p> Available <b>Credential Types </b> in the Credential Vault are defined externally in a credential type registry configuration file and can be retrieved through the method <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getCredentialTypes()"><CODE>getCredentialTypes()</CODE></A>that returns their respective type string. Default credential type strings are defined as constants in the interface <code>CredentialTypes</code>.<P><P><DL><DT><B>Since:</B></DT> <DD>5.1.0.1</DD></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/portal/portlet/service/credentialvault/CredentialVaultService.html#PREDEFINED_SLOT_USER_JAAS_SUBJECT">PREDEFINED_SLOT_USER_JAAS_SUBJECT</A></B></CODE><BR> This is the name of a predefined slot to store the transient JAAS credential.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#SECRET_TYPE_BYTEARRAY">SECRET_TYPE_BYTEARRAY</A></B></CODE><BR> The secret is given in the form of a byte array</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#SECRET_TYPE_JAAS_SUBJECT">SECRET_TYPE_JAAS_SUBJECT</A></B></CODE><BR> The secret is given in the form of a Jaas Subject</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#SECRET_TYPE_JAVA_OBJECT">SECRET_TYPE_JAVA_OBJECT</A></B></CODE><BR> The secret is a Java Object</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#SECRET_TYPE_NO_SECRET_DATA">SECRET_TYPE_NO_SECRET_DATA</A></B></CODE><BR> Type for credential objects that do not contain a secret.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#SECRET_TYPE_UNDEFINED">SECRET_TYPE_UNDEFINED</A></B></CODE><BR> Used only for the super class CredentialSecret of the secret classes as Secret Type, do not use this for creating Slots</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#SECRET_TYPE_USERID_STRING_PASSWORD_STRING">SECRET_TYPE_USERID_STRING_PASSWORD_STRING</A></B></CODE><BR> The secret type is userid / password</TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><!-- ========== 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> <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialSlotConfig.html" title="interface in com.ibm.portal.portlet.service.credentialvault">CredentialSlotConfig</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#createCredentialSlot(java.lang.String, com.ibm.portal.ObjectID, java.util.Map, java.util.Map, int, boolean, boolean, javax.portlet.PortletRequest)">createCredentialSlot</A></B>(java.lang.String resourceName, <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> segmentId, java.util.Map descriptions, java.util.Map keywords, int secretType, boolean active, boolean portletPrivate, javax.portlet.PortletRequest portletRequest)</CODE><BR> Creates a new credential slot in the given vault segment.</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/portal/portlet/service/credentialvault/CredentialVaultService.html#deleteCredentialSlot(java.lang.String)">deleteCredentialSlot</A></B>(java.lang.String slotName)</CODE><BR> Deletes an existing credential slot.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Iterator</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getAccessibleSlots(javax.portlet.PortletRequest)">getAccessibleSlots</A></B>(javax.portlet.PortletRequest request)</CODE><BR> Returns an iterator of all credential Slots that a portlet is authorized to use</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.List</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getAllCredentialSegments()">getAllCredentialSegments</A></B>()</CODE><BR> Returns a List of all available Vault Segments.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/Credential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials">Credential</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getCredential(java.lang.String, java.lang.String, java.util.Map, javax.portlet.PortletRequest)">getCredential</A></B>(java.lang.String slotId, java.lang.String type, java.util.Map config, javax.portlet.PortletRequest request)</CODE><BR> Returns a specific credential from a specific slot.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -