offapi/com/sun/star/task/PasswordContainer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_task_PasswordContainer_idl__
  28 #define __com_sun_star_task_PasswordContainer_idl__
  29
  30 module com {  module sun {  module star {
  31     module task {
  32         published interface XPasswordContainer;
  33         published interface XMasterPasswordHandling;
  34     };
  35 }; }; };
  36
  37 module com {  module sun {  module star {  module task {
  38 //============================================================================
  39 /** this service is kind of storage that allows to store passwords
  40     and to retrieve already stored.
  41
  42     <p>
  43     A password can be stored for the session period or persistently.
  44     The persistent way is only possible if configuration allows to use storage.
  45     It stores passwords encripted with a super password. An interaction
  46     is used to ask a user for a super password.
  47     To allow such an interaction, an object that implements <type>XInteractionHandler</type>
  48     interface should be provided. For this purpose <type>InteractionHandler</type>
  49     service can be used.
  50     </p>
  51
  52     <p>
  53     In case no interaction handler is provided all passwords are stored
  54     for the session period. In case an interaction handler is provided, but
  55     the super password interaction does not return super password ( for any reason ),
  56     <type>NoMasterException</type> exception is thrown to let user use
  57     nonpersistent way explicitly.
  58     </p>
  59 */
  60 published service PasswordContainer
  61 {
  62     //------------------------------------------------------------------------
  63     /** handles passwords
  64
  65         <p>
  66         Use this interface to store\retrieve passwords.
  67         </p>
  68      */
  69     interface com::sun::star::task::XPasswordContainer;
  70
  71     //------------------------------------------------------------------------
  72     /** handles passwords
  73
  74         <p>
  75         Use this interface to store\retrieve passwords.
  76         </p>
  77      */
  78     [optional] interface com::sun::star::task::XMasterPasswordHandling;
  79 };
  80
  81 }; }; }; };
  82 #endif