<html> <head> <title>Interface XSSOPasswordCache</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XSSOPasswordCache-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">auth</a> :: </p> </td> </tr> <tr> <td class="title">interface XSSOPasswordCache</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>supports password caching for security mechanisms which use passwords as credentials or as an input to credential creation but don't have an external method to cache these passwords. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#addPassword">addPassword</a></td> <td class="imsum_right">adds a username/password combination to the cache. </td> </tr> <tr> <td class="imsum_left"><a href="#getPassword">getPassword</a></td> <td class="imsum_right">retrieves a password for a given user from the cache. </td> </tr> <tr> <td class="imsum_left"><a href="#removePassword">removePassword</a></td> <td class="imsum_right">removes a password from the cache </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="addPassword" class="membertitle">addPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addPassword</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> UserName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Password,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> Persist )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidArgumentException.html">InvalidArgumentException</a>,<br> <a href="PersistenceFailureException.html">PersistenceFailureException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds a username/password combination to the cache. </dd> <dd><P> If an entry for the specified username already exists in the cache, it will be overwritten. </dd> <dt><b>Parameter UserName</b></dt> <dd>the user name to add </dd> <dt><b>Parameter Password</b></dt> <dd>the associated password </dd> <dt><b>Parameter Persist</b></dt> <dd>indicates whether or not the username/password combination should be persisted </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPassword" class="membertitle">getPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getPassword</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> UserName,</td> </tr> <tr> <td/><td valign="top">[out] boolean</td> <td valign="bottom"> Persist )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidArgumentException.html">InvalidArgumentException</a>,<br> <a href="PersistenceFailureException.html">PersistenceFailureException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves a password for a given user from the cache. </dd> <dd><P> Non persistent cache is searched first, followed by the persistent cache ( if it exists ). </dd> <dt><b>Parameter UserName</b></dt> <dd>the name of the user whose password should be retrieved </dd> <dt><b>Parameter Persist</b></dt> <dd>indicates whether or not the password is persistent </dd> <dt><b>Returns</b></dt> <dd>the required password </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removePassword" class="membertitle">removePassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removePassword</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> UserName,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> RemovePersist )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidArgumentException.html">InvalidArgumentException</a>,<br> <a href="PersistenceFailureException.html">PersistenceFailureException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a password from the cache </dd> <dt><b>Parameter UserName</b></dt> <dd>the name of the user whose password should be removed. </dd> <dt><b>Parameter RemovePersist</b></dt> <dd>indicates whether or not the password should also be removed, if present, from persistent cache. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>