credentialvaultservice.html

门户开发

<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getCredentialSlotDescription(java.lang.String, java.util.Locale)">getCredentialSlotDescription</A></B>(java.lang.String&nbsp;slotId,
                             java.util.Locale&nbsp;locale)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a credential slot's description for the specified locale.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.Iterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getCredentialTypes()">getCredentialTypes</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an Iterator over all available credential types that are
 registered in the credential type registry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getDefaultUserCredentialSegmentId()">getDefaultUserCredentialSegmentId</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the ObjectID of the default user managed vault segment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;javax.security.auth.Subject</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#getUserSubject(javax.portlet.PortletRequest)">getUserSubject</A></B>(javax.portlet.PortletRequest&nbsp;request)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the user's JAAS Subject.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#setCredentialSecretBinary(java.lang.String, byte[], javax.portlet.PortletRequest)">setCredentialSecretBinary</A></B>(java.lang.String&nbsp;slotId,
                          byte[]&nbsp;secret,
                          javax.portlet.PortletRequest&nbsp;portletRequest)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a credential's binary secret on a given slot.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html#setCredentialSecretUserPassword(java.lang.String, java.lang.String, char[], javax.portlet.PortletRequest)">setCredentialSecretUserPassword</A></B>(java.lang.String&nbsp;slotId,
                                java.lang.String&nbsp;userId,
                                char[]&nbsp;password,
                                javax.portlet.PortletRequest&nbsp;portletRequest)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a credential's user/password secret on a given slot.</TD>
</TR>
</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="SECRET_TYPE_UNDEFINED"><!-- --></A><H3>
SECRET_TYPE_UNDEFINED</H3>
<PRE>
public static final int <B>SECRET_TYPE_UNDEFINED</B></PRE>
<DL>
<DD>Used only for the super class CredentialSecret of the secret classes as
 Secret Type, do not use this for creating Slots
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.CredentialVaultService.SECRET_TYPE_UNDEFINED">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SECRET_TYPE_USERID_STRING_PASSWORD_STRING"><!-- --></A><H3>
SECRET_TYPE_USERID_STRING_PASSWORD_STRING</H3>
<PRE>
public static final int <B>SECRET_TYPE_USERID_STRING_PASSWORD_STRING</B></PRE>
<DL>
<DD>The secret type is userid / password
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.CredentialVaultService.SECRET_TYPE_USERID_STRING_PASSWORD_STRING">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SECRET_TYPE_BYTEARRAY"><!-- --></A><H3>
SECRET_TYPE_BYTEARRAY</H3>
<PRE>
public static final int <B>SECRET_TYPE_BYTEARRAY</B></PRE>
<DL>
<DD>The secret is given in the form of a byte array
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.CredentialVaultService.SECRET_TYPE_BYTEARRAY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SECRET_TYPE_JAVA_OBJECT"><!-- --></A><H3>
SECRET_TYPE_JAVA_OBJECT</H3>
<PRE>
public static final int <B>SECRET_TYPE_JAVA_OBJECT</B></PRE>
<DL>
<DD>The secret is a Java Object
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.CredentialVaultService.SECRET_TYPE_JAVA_OBJECT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SECRET_TYPE_NO_SECRET_DATA"><!-- --></A><H3>
SECRET_TYPE_NO_SECRET_DATA</H3>
<PRE>
public static final int <B>SECRET_TYPE_NO_SECRET_DATA</B></PRE>
<DL>
<DD>Type for credential objects that do not contain a secret. The credential
 only knows where to get the secret.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.CredentialVaultService.SECRET_TYPE_NO_SECRET_DATA">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SECRET_TYPE_JAAS_SUBJECT"><!-- --></A><H3>
SECRET_TYPE_JAAS_SUBJECT</H3>
<PRE>
public static final int <B>SECRET_TYPE_JAAS_SUBJECT</B></PRE>
<DL>
<DD>The secret is given in the form of a Jaas Subject
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.ibm.portal.portlet.service.credentialvault.CredentialVaultService.SECRET_TYPE_JAAS_SUBJECT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PREDEFINED_SLOT_USER_JAAS_SUBJECT"><!-- --></A><H3>
PREDEFINED_SLOT_USER_JAAS_SUBJECT</H3>
<PRE>
public static final java.lang.String <B>PREDEFINED_SLOT_USER_JAAS_SUBJECT</B></PRE>
<DL>
<DD>This is the name of a predefined slot to store the transient JAAS
 credential.
<P>
<DL>
</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="getCredentialTypes()"><!-- --></A><H3>
getCredentialTypes</H3>
<PRE>
public java.util.Iterator <B>getCredentialTypes</B>()</PRE>
<DL>
<DD>Returns an Iterator over all available credential types that are
 registered in the credential type registry. The result of this method can
 vary from the default types in the interface <code>CredentialTypes</code>
 dependent on the actual portal configuration.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Iterator over <code>String</code> objects representing all
         credential types that are registered in the credential type
         registry</DL>
</DD>
</DL>
<HR>

<A NAME="getCredentialSlotDescription(java.lang.String, java.util.Locale)"><!-- --></A><H3>
getCredentialSlotDescription</H3>
<PRE>
public java.lang.String <B>getCredentialSlotDescription</B>(java.lang.String&nbsp;slotId,
                                                     java.util.Locale&nbsp;locale)
                                              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>Returns a credential slot's description for the specified locale.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slotId</CODE> - The credential (slot) id.<DD><CODE>locale</CODE> - The description locale. If set to <code>null</code>, the
        default locale will be used.
<DT><B>Returns:</B><DD>String The credential slot description for the specified locale.
<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 the description could not been
            retrieved.</DL>
</DD>
</DL>
<HR>

<A NAME="getAccessibleSlots(javax.portlet.PortletRequest)"><!-- --></A><H3>
getAccessibleSlots</H3>
<PRE>
public java.util.Iterator <B>getAccessibleSlots</B>(javax.portlet.PortletRequest&nbsp;request)
                                      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>Returns an iterator of all credential Slots that a portlet is authorized
 to use
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The portlet request is needed by the CredentialVault
        service in order to determine information about the portlet.
<DT><B>Returns:</B><DD>Iterator over <code>CredentialSlotConfig</code> objects
         representing all credential slots that a portlet is authorized to
         use
<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 the list of Slots could not been
            retrieved.</DL>
</DD>
</DL>
<HR>

<A NAME="setCredentialSecretBinary(java.lang.String, byte[], javax.portlet.PortletRequest)"><!-- --></A><H3>
setCredentialSecretBinary</H3>
<PRE>
public void <B>setCredentialSecretBinary</B>(java.lang.String&nbsp;slotId,
                                      byte[]&nbsp;secret,
                                      javax.portlet.PortletRequest&nbsp;portletRequest)
                               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>Sets a credential's binary secret on a given slot.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slotId</CODE> - The credential (slot) id.<DD><CODE>secret</CODE> - The credential secret data in binary form.<DD><CODE>portletRequest</CODE> - The portlet request is used to determine parameters
        like the portlet id and user id.
<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 the credential secret is not of
            the type binary or if the secret could not be set.</DL>
</DD>
</DL>
<HR>

<A NAME="setCredentialSecretUserPassword(java.lang.String, java.lang.String, char[], javax.portlet.PortletRequest)"><!-- --></A><H3>
setCredentialSecretUserPassword</H3>
<PRE>
public void <B>setCredentialSecretUserPassword</B>(java.lang.String&nbsp;slotId,