credentialvaultservice.html

门户开发

<A NAME="deleteSlot(java.lang.String)"><!-- --></A><H3>
deleteSlot</H3>
<PRE>
public void <B>deleteSlot</B>(java.lang.String&nbsp;slotName)
                throws <A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Deletes an existing credential slot. The parameter is the Slot ID that
 can be retrieved through
 <A HREF="../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialSlotConfig.html#getSlotId()"><CODE>CredentialSlotConfig#getSlotId()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slotName</CODE> - The credential (slot) id.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - Is thrown if the credential slot could
            not be deleted or found.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultUserVaultSegmentId()"><!-- --></A><H3>
getDefaultUserVaultSegmentId</H3>
<PRE>
public com.ibm.wps.util.ObjectID <B>getDefaultUserVaultSegmentId</B>()
                                                       throws <A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use
             <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialVaultService.html#getDefaultUserVaultSegmentPortalId()"><CODE>getDefaultUserVaultSegmentPortalId()</CODE></A>
             instead.</I>
<P>
<DD>Returns the ObjectID of the default user managed vault segment. Currently
 there is only one user-managed segment, so this returns the ID of <i>the
 </i> user managed segment.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The ObjectID of the default user managed vault segment, or
         <code>null</code>, if no user managed vault segment is
         configured in the system.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - Is thrown if the user segment could
            not be found.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultUserVaultSegmentPortalId()"><!-- --></A><H3>
getDefaultUserVaultSegmentPortalId</H3>
<PRE>
public <A HREF="../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>getDefaultUserVaultSegmentPortalId</B>()
                                            throws <A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the ObjectID of the default user managed vault segment. Currently
 there is only one user-managed segment, so this returns the ID of <i>the
 </i> user managed segment.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The ObjectID of the default user managed vault segment, or
         <code>null</code>, if no user managed vault segment is
         configured in the system.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - Is thrown if the user segment could
            not be found.</DL>
</DD>
</DL>
<HR>

<A NAME="getAllVaultSegments()"><!-- --></A><H3>
getAllVaultSegments</H3>
<PRE>
public java.util.List <B>getAllVaultSegments</B>()
                                   throws <A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns a List of all available Vault Segments.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>List of <code>VaultSegmentConfig</code> objects representing
         all vault segments.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - Is thrown if the segments could not be
            retrieved.</DL>
</DD>
</DL>
<HR>

<A NAME="getCredential(java.lang.String, java.lang.String, java.util.Map, org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
getCredential</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/credentials/Credential.html" title="class in com.ibm.wps.portletservice.credentialvault.credentials">Credential</A> <B>getCredential</B>(java.lang.String&nbsp;slotId,
                                java.lang.String&nbsp;type,
                                java.util.Map&nbsp;config,
                                <A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request)
                         throws <A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A>,
                                <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialSecretNotSetException.html" title="class in com.ibm.wps.portletservice.credentialvault">CredentialSecretNotSetException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns a specific credential from a specific slot. The type of the
 credential has to map the type of the stored credential. The parameter is
 the Slot ID that can be retrieved through
 <A HREF="../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialSlotConfig.html#getSlotId()"><CODE>CredentialSlotConfig#getSlotId()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slotId</CODE> - The credential (slot) id.<DD><CODE>type</CODE> - The credential type as specified in the credential type
        registry. Default credential type strings are defined as constants
        in the interface <code>CredentialTypes</code>.<DD><CODE>config</CODE> - The backend application specific configuration that is
        needed to initialize this credential. This is one part of the
        credential configuration. The credential vault service will
        usually add further information to this config from other sources:
        the user's secret from the actual credential store and the
        credential instance specific parameters from the portal's
        credential configuration. This parameter can be null.<DD><CODE>request</CODE> - The portlet request is used to determine information about
        the portlet.
<DT><B>Returns:</B><DD>The retrieved credential object. The actual object will match the
         Credential Type.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - if the credential could not been
            retrieved - either for technical or secuity reasons.
<DD><CODE><A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialSecretNotSetException.html" title="class in com.ibm.wps.portletservice.credentialvault">CredentialSecretNotSetException</A></CODE> - if the requested credential
            secret is not set (by the user or admin).</DL>
</DD>
</DL>
<HR>

<A NAME="getUserSubject(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
getUserSubject</H3>
<PRE>
public javax.security.auth.Subject <B>getUserSubject</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request)
                                           throws <A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the user's JAAS Subject. The JAAS Subject is retrieved from the
 user object, so this method should only be called if a user is currently
 logged in. Otherwise a <code>PortletServiceException</code> is thrown.
 Note: The returned object is a transient credential.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The portlet request is used to determine the user.
<DT><B>Returns:</B><DD>The user's JAAS Subject.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - if the subject could not been
            retrieved, e.g. because there is no logged in user.</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/wps/portletservice/credentialvault/CredentialTypes.html" title="interface in com.ibm.wps.portletservice.credentialvault"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/VaultSegmentConfig.html" title="interface in com.ibm.wps.portletservice.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>  &nbsp;
&nbsp;<A HREF="CredentialVaultService.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>