offapi/com/sun/star/auth/XSSOPasswordCache.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_auth_XSSOPasswordCache_idl__
  21 #define __com_sun_star_auth_XSSOPasswordCache_idl__
  22
  23 #include <com/sun/star/auth/InvalidArgumentException.idl>
  24 #include <com/sun/star/auth/PersistenceFailureException.idl>
  25 #include <com/sun/star/uno/XInterface.idl>
  26
  27 module com { module sun { module star { module auth {
  28
  29 /** supports password caching for security mechanisms which use passwords as
  30     credentials or as an input to credential creation but don't have
  31     an external method to cache these passwords.
  32
  33     @since OOo 1.1.2
  34  */
  35
  36 published interface XSSOPasswordCache : ::com::sun::star::uno::XInterface
  37 {
  38     /** adds a username/password combination to the cache.
  39         <P>
  40         If an entry for the specified username already exists in the cache, it
  41         will be overwritten.
  42
  43         @param UserName
  44         the user name to add
  45
  46         @param Password
  47         the associated password
  48
  49         @param Persist
  50         indicates whether or not the username/password combination should be
  51         persisted
  52      */
  53     void    addPassword( [in] string UserName,
  54                          [in] string Password,
  55                          [in] boolean Persist )
  56                 raises( InvalidArgumentException,
  57                         PersistenceFailureException );
  58
  59     /** retrieves a password for a given user from the cache.
  60         <P>
  61         Non persistent cache is searched first, followed by the
  62         persistent cache ( if it exists ).
  63
  64         @param UserName
  65         the name of the user whose password should be retrieved
  66
  67         @param Persist
  68         indicates whether or not the password is persistent
  69
  70         @returns
  71         the required password
  72      */
  73     string  getPassword( [in] string UserName, [out] boolean Persist )
  74                 raises( InvalidArgumentException,
  75                         PersistenceFailureException );
  76
  77     /** removes a password from the cache
  78
  79         @param UserName
  80         the name of the user whose password should be removed.
  81
  82         @param RemovePersist
  83         indicates whether or not the password should also be removed, if
  84         present, from persistent cache.
  85      */
  86     void    removePassword( [in] string UserName, [in] boolean RemovePersist )
  87                 raises( InvalidArgumentException,
  88                         PersistenceFailureException );
  89 };
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */