credentialslotconfig.html

门户开发

<A NAME="setVaultSlotDescription(java.lang.String, java.util.Locale)"><!-- --></A><H3>
setVaultSlotDescription</H3>
<PRE>
public void <B>setVaultSlotDescription</B>(java.lang.String&nbsp;description,
                                    java.util.Locale&nbsp;locale)</PRE>
<DL>
<DD>Sets a description for this vault slot in the provided locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>description</CODE> - Translated Description. The description is set to null
                    if the parameter is null.<DD><CODE>locale</CODE> - The Locale the description is in; without a locale nothing is set.</DL>
</DD>
</DL>
<HR>

<A NAME="getVaultSlotDescription()"><!-- --></A><H3>
getVaultSlotDescription</H3>
<PRE>
public java.lang.String <B>getVaultSlotDescription</B>()</PRE>
<DL>
<DD>Returns the description for this Vault Slot in the portal default locale as specified 
 in the portal configuration.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Vault Slot description in the default locale</DL>
</DD>
</DL>
<HR>

<A NAME="setVaultSlotDescription(java.lang.String)"><!-- --></A><H3>
setVaultSlotDescription</H3>
<PRE>
public void <B>setVaultSlotDescription</B>(java.lang.String&nbsp;description)</PRE>
<DL>
<DD>Sets the description for this Vault Slot in the portal default locale as specified 
 in the portal configuration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>description</CODE> - Description</DL>
</DD>
</DL>
<HR>

<A NAME="getVaultSlotDescriptionsMap()"><!-- --></A><H3>
getVaultSlotDescriptionsMap</H3>
<PRE>
public java.util.Map <B>getVaultSlotDescriptionsMap</B>()</PRE>
<DL>
<DD>Returns a map of all the descriptions for this Vault Slot.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Map from <code>java.util.Locale</code> to <code>String</code>.  
         Map of all the descriptions for this Vault Slot, keyed by the locale.</DL>
</DD>
</DL>
<HR>

<A NAME="setVaultSlotDescriptions(java.util.Map)"><!-- --></A><H3>
setVaultSlotDescriptions</H3>
<PRE>
public void <B>setVaultSlotDescriptions</B>(java.util.Map&nbsp;slotDescriptions)</PRE>
<DL>
<DD>Sets all the VaultSlot Descriptions. If the map is empty, nothing is set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slotDescriptions</CODE> - Descriptions as string, keyed by locale (Map from <code>java.util.Locale</code> to <code>String</code>.).</DL>
</DD>
</DL>
<HR>

<A NAME="getVaultSlotKeywords(java.util.Locale)"><!-- --></A><H3>
getVaultSlotKeywords</H3>
<PRE>
public java.lang.String <B>getVaultSlotKeywords</B>(java.util.Locale&nbsp;locale)</PRE>
<DL>
<DD>Returns the keywords for this Vault Slot in the provided locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - Locale of the keywords to be returned
               If the keywords for the given locale are not available, this method
               will return the keywords for the portal default
               Locale, as specified in the portal configuration.
<DT><B>Returns:</B><DD>The keywords for this Vault Slot in the specified locale</DL>
</DD>
</DL>
<HR>

<A NAME="setVaultSlotKeywords(java.lang.String, java.util.Locale)"><!-- --></A><H3>
setVaultSlotKeywords</H3>
<PRE>
public void <B>setVaultSlotKeywords</B>(java.lang.String&nbsp;keywords,
                                 java.util.Locale&nbsp;locale)</PRE>
<DL>
<DD>Sets the keywords for this Vault Slot in the provided locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>keywords</CODE> - Translated keywords, can be any string. If the keyword is null,
                 null is set as keyword.<DD><CODE>locale</CODE> - Locale of the keywords. Nothing is set, if the locale is null.</DL>
</DD>
</DL>
<HR>

<A NAME="getVaultSlotKeywords()"><!-- --></A><H3>
getVaultSlotKeywords</H3>
<PRE>
public java.lang.String <B>getVaultSlotKeywords</B>()</PRE>
<DL>
<DD>Returns the keywords for this Vault Slot in the portal default locale, as specified in the portal configuration.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Vault Slot keywords in the default locale</DL>
</DD>
</DL>
<HR>

<A NAME="setVaultSlotKeywords(java.lang.String)"><!-- --></A><H3>
setVaultSlotKeywords</H3>
<PRE>
public void <B>setVaultSlotKeywords</B>(java.lang.String&nbsp;keywords)</PRE>
<DL>
<DD>Sets the keywords for this Vault Slot in the portal default locale, as specified in the portal configuration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>keywords</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getVaultSlotKeywordsMap()"><!-- --></A><H3>
getVaultSlotKeywordsMap</H3>
<PRE>
public java.util.Map <B>getVaultSlotKeywordsMap</B>()</PRE>
<DL>
<DD>Returns a map of all the keywords for this Vault Slot.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Map of all the keywords for this Vault Slot, keyed
         by locale.</DL>
</DD>
</DL>
<HR>

<A NAME="setVaultSlotKeywords(java.util.Map)"><!-- --></A><H3>
setVaultSlotKeywords</H3>
<PRE>
public void <B>setVaultSlotKeywords</B>(java.util.Map&nbsp;slotKeywords)</PRE>
<DL>
<DD>Sets all the Vault Slot keywords.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slotKeywords</CODE> - Map of all keywords, keyed by locale (Map from <code>java.util.Locale</code> to <code>String</code).</DL>
</DD>
</DL>
<HR>

<A NAME="getResourceName()"><!-- --></A><H3>
getResourceName</H3>
<PRE>
public java.lang.String <B>getResourceName</B>()</PRE>
<DL>
<DD>Returns the resource name for this Vault Slot. There is always a resource name.
 Note: This is not the Credential Slot's ID, which is often used to access or modify the slot.
 For such a purpose, retrieve the Slot ID through <A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialSlotConfig.html#getSlotId()"><CODE>getSlotId()</CODE></A>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>String the resource name</DL>
</DD>
</DL>
<HR>

<A NAME="getSegmentPortalObjectID()"><!-- --></A><H3>
getSegmentPortalObjectID</H3>
<PRE>
public <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>getSegmentPortalObjectID</B>()</PRE>
<DL>
<DD>Returns the Object ID of the Segment this Vault Slot belongs to.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>ObjectID The Object ID of the Segment for this Vault Slot</DL>
</DD>
</DL>
<HR>

<A NAME="getSecretType()"><!-- --></A><H3>
getSecretType</H3>
<PRE>
public int <B>getSecretType</B>()</PRE>
<DL>
<DD>Returns the Credential Slot's Secret Type (ID). The Secret Type constants are definied in the 
 <code>CredentialVaultService</code> class.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>int
         The Credential Slot's Secret Type<DT><B>See Also:</B><DD><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialVaultService.html" title="interface in com.ibm.portal.portlet.service.credentialvault"><CODE>CredentialVaultService</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isUserManaged()"><!-- --></A><H3>
isUserManaged</H3>
<PRE>
public boolean <B>isUserManaged</B>()</PRE>
<DL>
<DD>Returns if this Vault Slot is user managed or not.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if this Vault Slot is user managed, <code>false</code> if it is admin
         managed.</DL>
</DD>
</DL>
<HR>

<A NAME="referencesSystemCredential()"><!-- --></A><H3>
referencesSystemCredential</H3>
<PRE>
public boolean <B>referencesSystemCredential</B>()</PRE>
<DL>
<DD>Returns if this Vault Slot references a System Credential (i.e., every
 access maps to the same secret). Note: only admin managed vault slots may
 reference system credentials.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if this Vault Slot references a System Credential, <code>false</code> if it references a User or Admin Credentila (non-system).</DL>
</DD>
</DL>
<HR>

<A NAME="getPortalCPIID()"><!-- --></A><H3>
getPortalCPIID</H3>
<PRE>
public <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>getPortalCPIID</B>()</PRE>
<DL>
<DD>If this Vault Slot is user managed and portlet private (a user managed portlet private slot), this method returns the 
 Portlet Instance ID of the portlet. 
 Through this CPIID, the Credential Vault makes sure that only the portlet that originally created this Slot can access it.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>CPIID of the portlet, null if the Slot is not portlet private or not
         user managed</DL>
</DD>
</DL>
<HR>

<A NAME="getActive()"><!-- --></A><H3>
getActive</H3>
<PRE>
public boolean <B>getActive</B>()</PRE>
<DL>
<DD>Returns the Credential Slot's active/passive flag.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if the credential secret in this slot may only be provided in form of
          an active credential object, <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/ActiveCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials"><CODE>ActiveCredential</CODE></A>, 
<A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/PassiveCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials"><CODE>PassiveCredential</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setActive(boolean)"><!-- --></A><H3>
setActive</H3>
<PRE>
public void <B>setActive</B>(boolean&nbsp;active)</PRE>
<DL>
<DD>Sets the Credential Slot's active/passive flag.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>active</CODE> - Set to <code>true</code> if the credential secret in this slot may only be provided in form of an active 
        credential object, to <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/ActiveCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials"><CODE>ActiveCredential</CODE></A>, 
<A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/credentials/PassiveCredential.html" title="interface in com.ibm.portal.portlet.service.credentialvault.credentials"><CODE>PassiveCredential</CODE></A></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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../com/ibm/portal/portlet/service/credentialvault/CredentialTypes.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>  &nbsp;
&nbsp;<A HREF="CredentialSlotConfig.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&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>