LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XSSOPasswordCache Interface Referencepublished

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. More...

import"XSSOPasswordCache.idl";

Inheritance diagram for XSSOPasswordCache:
XInterface SSOPasswordCache

Public Member Functions

void addPassword ([in] string UserName, [in] string Password, [in] boolean Persist) raises ( InvalidArgumentException, PersistenceFailureException )
 adds a username/password combination to the cache. More...
 
string getPassword ([in] string UserName, [out] boolean Persist) raises ( InvalidArgumentException, PersistenceFailureException )
 retrieves a password for a given user from the cache. More...
 
void removePassword ([in] string UserName, [in] boolean RemovePersist) raises ( InvalidArgumentException, PersistenceFailureException )
 removes a password from the cache More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed 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

Member Function Documentation

void addPassword ( [in] string  UserName,
[in] string  Password,
[in] boolean  Persist 
)
raises ( InvalidArgumentException,
PersistenceFailureException
)

adds a username/password combination to the cache.

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

Parameters
UserNamethe user name to add
Passwordthe associated password
Persistindicates whether or not the username/password combination should be persisted
string getPassword ( [in] string  UserName,
[out] boolean  Persist 
)
raises ( InvalidArgumentException,
PersistenceFailureException
)

retrieves a password for a given user from the cache.

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

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

removes a password from the cache

Parameters
UserNamethe name of the user whose password should be removed.
RemovePersistindicates whether or not the password should also be removed, if present, from persistent cache.

The documentation for this interface was generated from the following file: