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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSSOPasswordCache.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_auth_XSSOPasswordCache_idl__
  32 #define __com_sun_star_auth_XSSOPasswordCache_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_auth_SSOExceptions_idl__
  39 #include <com/sun/star/auth/SSOExceptions.idl>
  40 #endif
  41
  42 module com { module sun { module star { module auth {
  43
  44 /** supports password caching for security mechanisms which use passwords as
  45     credentials or as an input to credential creation but don't have
  46     an external method to cache these passwords.
  47
  48     @since OOo 1.1.2
  49  */
  50
  51 published interface XSSOPasswordCache : ::com::sun::star::uno::XInterface
  52 {
  53     /** adds a username/password combination to the cache.
  54         <P>
  55         If an entry for the specified username already exists in the cache, it
  56         will be overwritten.
  57
  58         @param UserName
  59         the user name to add
  60
  61         @param Password
  62         the associated password
  63
  64         @param Persist
  65         indicates whether or not the username/password combination should be
  66         persisted
  67      */
  68     void        addPassword( [in] string UserName,
  69                          [in] string Password,
  70                          [in] boolean Persist )
  71                 raises( InvalidArgumentException,
  72                         PersistenceFailureException );
  73
  74     /** retrieves a password for a given user from the cache.
  75         <P>
  76         Non persistent cache is searched first, followed by the
  77         persistent cache ( if it exists ).
  78
  79         @param UserName
  80         the name of the user whose password should be retrieved
  81
  82         @param Persist
  83         indicates whether or not the password is persistent
  84
  85         @returns
  86         the required password
  87      */
  88     string      getPassword( [in] string UserName, [out] boolean Persist )
  89                 raises( InvalidArgumentException,
  90                         PersistenceFailureException );
  91
  92     /** removes a password from the cache
  93
  94         @param UserName
  95         the name of the user whose password should be removed.
  96
  97         @param RemovePersist
  98         indicates whether or not the password should also be removed, if
  99         present, from persistent cache.
 100      */
 101     void        removePassword( [in] string UserName, [in] boolean RemovePersist )
 102                 raises( InvalidArgumentException,
 103                         PersistenceFailureException );
 104 };
 105
 106 }; }; }; };
 107
 108 #endif