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 module com { module sun { module star { module auth {
  21
  22 /** supports password caching for security mechanisms which use passwords as
  23     credentials or as an input to credential creation but don't have
  24     an external method to cache these passwords.
  25
  26     @since OOo 1.1.2
  27  */
  28
  29 published interface XSSOPasswordCache : ::com::sun::star::uno::XInterface
  30 {
  31     /** adds a username/password combination to the cache.
  32         <P>
  33         If an entry for the specified username already exists in the cache, it
  34         will be overwritten.
  35
  36         @param UserName
  37         the user name to add
  38
  39         @param Password
  40         the associated password
  41
  42         @param Persist
  43         indicates whether or not the username/password combination should be
  44         persisted
  45      */
  46     void    addPassword( [in] string UserName,
  47                          [in] string Password,
  48                          [in] boolean Persist )
  49                 raises( InvalidArgumentException,
  50                         PersistenceFailureException );
  51
  52     /** retrieves a password for a given user from the cache.
  53         <P>
  54         Non persistent cache is searched first, followed by the
  55         persistent cache ( if it exists ).
  56
  57         @param UserName
  58         the name of the user whose password should be retrieved
  59
  60         @param Persist
  61         indicates whether or not the password is persistent
  62
  63         @returns
  64         the required password
  65      */
  66     string  getPassword( [in] string UserName, [out] boolean Persist )
  67                 raises( InvalidArgumentException,
  68                         PersistenceFailureException );
  69
  70     /** removes a password from the cache
  71
  72         @param UserName
  73         the name of the user whose password should be removed.
  74
  75         @param RemovePersist
  76         indicates whether or not the password should also be removed, if
  77         present, from persistent cache.
  78      */
  79     void    removePassword( [in] string UserName, [in] boolean RemovePersist )
  80                 raises( InvalidArgumentException,
  81                         PersistenceFailureException );
  82 };
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */