credentialvaultservice.html

门户开发

<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><B>Deprecated.</B>&nbsp;<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="getSlotDescription(java.lang.String, java.util.Locale)"><!-- --></A><H3>
getSlotDescription</H3>
<PRE>
public java.lang.String <B>getSlotDescription</B>(java.lang.String&nbsp;slotId,
                                           java.util.Locale&nbsp;locale)
                                    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 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>The credential slot description for the specified locale.
<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 description could not been
            retrieved.</DL>
</DD>
</DL>
<HR>

<A NAME="getAccessibleSlots(org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
getAccessibleSlots</H3>
<PRE>
public java.util.Iterator <B>getAccessibleSlots</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 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="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - if the list of slots could not been
            retrieved.</DL>
</DD>
</DL>
<HR>

<A NAME="setCredentialSecretBinary(java.lang.String, byte[], org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
setCredentialSecretBinary</H3>
<PRE>
public void <B>setCredentialSecretBinary</B>(java.lang.String&nbsp;slotId,
                                      byte[]&nbsp;secret,
                                      <A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;portletRequest)
                               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>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="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</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[], org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
setCredentialSecretUserPassword</H3>
<PRE>
public void <B>setCredentialSecretUserPassword</B>(java.lang.String&nbsp;slotId,
                                            java.lang.String&nbsp;userId,
                                            char[]&nbsp;password,
                                            <A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;portletRequest)
                                     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>Sets a credential's user/password 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>userId</CODE> - The credential's userId.<DD><CODE>password</CODE> - The credential's password.<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="../../../../../org/apache/jetspeed/portlet/service/PortletServiceException.html" title="class in org.apache.jetspeed.portlet.service">PortletServiceException</A></CODE> - if the credential secret is not of the
            type user/password or if the secret could not be set.</DL>
</DD>
</DL>
<HR>

<A NAME="createSlot(java.lang.String, com.ibm.wps.util.ObjectID, java.util.Map, java.util.Map, int, boolean, boolean, org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
createSlot</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialSlotConfig.html" title="interface in com.ibm.wps.portletservice.credentialvault">CredentialSlotConfig</A> <B>createSlot</B>(java.lang.String&nbsp;resourceName,
                                       com.ibm.wps.util.ObjectID&nbsp;segmentId,
                                       java.util.Map&nbsp;descriptions,
                                       java.util.Map&nbsp;keywords,
                                       int&nbsp;secretType,
                                       boolean&nbsp;active,
                                       boolean&nbsp;portletPrivate,
                                       <A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;portletRequest)
                                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 method
             <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialVaultService.html#createSlot(java.lang.String, com.ibm.portal.ObjectID, java.util.Map, java.util.Map, int, boolean, boolean, org.apache.jetspeed.portlet.PortletRequest)"><CODE>createSlot(String, com.ibm.portal.ObjectID, Map, Map, int, boolean, boolean, PortletRequest)</CODE></A>
             taking a com.ibm.portal.ObjectID for the segmentId as
             parameter.</I>
<P>
<DD>Creates a new credential slot in the given vault segment. This method
 should be used by "ordinary" portlets, but not by "admin portlets",
 because this method only allows to create non system slots. The returned
 <code>CredentialSlotConfig</code> object holds the Slot ID of the newly
 generated slot. If one of the required parameters is null, an exception
 is thrown.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - Name of the resource. Must not be null.<DD><CODE>segmentId</CODE> - ObjectId of the segment that this slot is created in.
        Must not be null. Must be the ObjectID of a user mapped segment.
        As there is currently just one user mapped segment in the system,
        this parameter must contain the result of the method
        <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialVaultService.html#getDefaultUserVaultSegmentId()"><CODE>getDefaultUserVaultSegmentId()</CODE></A>!<DD><CODE>descriptions</CODE> - The slot descriptions as a <code>Map</code>, keyed
        by their corresponding <code>Locale</code> objects Key:
        <code>Locale</code> (max length 64 characters) Value:
        <code>String</code> (max length 255 characters) The given map
        can be empty.<DD><CODE>keywords</CODE> - The slot keywords as a <code>Map</code>, keyed by
        their corresponding <code>Locale</code> objects Key:
        <code>Locale</code> (max length 64 characters). Can be null.
        Value: <code>String</code> (max length 255 characters) The given
        map can be empty.<DD><CODE>secretType</CODE> - The secrtet type identifier. Must not be null.<DD><CODE>active</CODE> - Flag whether this credential may only be returned in form
        of an active credential object (<code>true</code>) or both as
        active and passive credential objects (<code>false</code>)<DD><CODE>portletPrivate</CODE> - Flag whether the credential secret is portlet
        secific (<code>true</code>) or shared between all of a user's
        portlets (<code>false</code>).<DD><CODE>portletRequest</CODE> - The portlet request. Must not be null.
<DT><B>Returns:</B><DD>CredentialSlot The credential slot configuration as
         <code>CredentialSlotConfig</code> object.
<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></DL>
</DD>
</DL>
<HR>

<A NAME="createSlot(java.lang.String, com.ibm.portal.ObjectID, java.util.Map, java.util.Map, int, boolean, boolean, org.apache.jetspeed.portlet.PortletRequest)"><!-- --></A><H3>
createSlot</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialSlotConfig.html" title="interface in com.ibm.wps.portletservice.credentialvault">CredentialSlotConfig</A> <B>createSlot</B>(java.lang.String&nbsp;resourceName,
                                       <A HREF="../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;segmentId,
                                       java.util.Map&nbsp;descriptions,
                                       java.util.Map&nbsp;keywords,
                                       int&nbsp;secretType,
                                       boolean&nbsp;active,
                                       boolean&nbsp;portletPrivate,
                                       <A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;portletRequest)
                                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>Creates a new credential slot in the given vault segment. This method
 should be used by "ordinary" portlets, but not by "admin portlets",
 because this method only allows to create non system slots. The returned
 <code>CredentialSlotConfig</code> object holds the Slot ID of the newly
 generated slot. If one of the required parameters is null, an exception
 is thrown.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - Name of the resource. Must not be null.<DD><CODE>segmentId</CODE> - ObjectId of the segment that this slot is created in.
        Must not be null. Must be the ObjectID of a user mapped segment.
        As there is currently just one user mapped segment in the system,
        this parameter must contain the result of the method
        <A HREF="../../../../../com/ibm/wps/portletservice/credentialvault/CredentialVaultService.html#getDefaultUserVaultSegmentPortalId()"><CODE>getDefaultUserVaultSegmentPortalId()</CODE></A>!<DD><CODE>descriptions</CODE> - The slot descriptions as a <code>Map</code>, keyed
        by their corresponding <code>Locale</code> objects Key:
        <code>Locale</code> (max length 64 characters) Value:
        <code>String</code> (max length 255 characters) The given map
        can be empty.<DD><CODE>keywords</CODE> - The slot keywords as a <code>Map</code>, keyed by
        their corresponding <code>Locale</code> objects Key:
        <code>Locale</code> (max length 64 characters). Can be null.
        Value: <code>String</code> (max length 255 characters) The given
        map can be empty.<DD><CODE>secretType</CODE> - The secrtet type identifier. Must not be null.<DD><CODE>active</CODE> - Flag whether this credential may only be returned in form
        of an active credential object (<code>true</code>) or both as
        active and passive credential objects (<code>false</code>)<DD><CODE>portletPrivate</CODE> - Flag whether the credential secret is portlet
        secific (<code>true</code>) or shared between all of a user's
        portlets (<code>false</code>).<DD><CODE>portletRequest</CODE> - The portlet request. Must not be null.
<DT><B>Returns:</B><DD>CredentialSlot The credential slot configuration as
         <code>CredentialSlotConfig</code> object.
<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></DL>
</DD>
</DL>
<HR>