Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: auth ::

interface XSSOPasswordCache
Description
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.
Since
OOo 1.1.2

Methods' Summary
addPassword adds a username/password combination to the cache.  
getPassword retrieves a password for a given user from the cache.  
removePassword removes a password from the cache  
Methods' Details
addPassword
void
addPassword( [in] string  UserName,
[in] string  Password,
[in] boolean  Persist )
raises( InvalidArgumentException,
PersistenceFailureException );

Description
adds a username/password combination to the cache.

If an entry for the specified username already exists in the cache, it will be overwritten.

Parameter UserName
the user name to add
Parameter Password
the associated password
Parameter Persist
indicates whether or not the username/password combination should be persisted
getPassword
string
getPassword( [in] string  UserName,
[out] boolean  Persist )
raises( InvalidArgumentException,
PersistenceFailureException );

Description
retrieves a password for a given user from the cache.

Non persistent cache is searched first, followed by the persistent cache ( if it exists ).

Parameter UserName
the name of the user whose password should be retrieved
Parameter Persist
indicates whether or not the password is persistent
Returns
the required password
removePassword
void
removePassword( [in] string  UserName,
[in] boolean  RemovePersist )
raises( InvalidArgumentException,
PersistenceFailureException );

Description
removes a password from the cache
Parameter UserName
the name of the user whose password should be removed.
Parameter RemovePersist
indicates whether or not the password should also be removed, if present, from persistent cache.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.