offapi/com/sun/star/task/PasswordContainer.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 #ifndef __com_sun_star_task_PasswordContainer_idl__
  20 #define __com_sun_star_task_PasswordContainer_idl__
  21
  22 module com {  module sun {  module star {
  23     module task {
  24         published interface XPasswordContainer2;
  25     };
  26 }; }; };
  27
  28 module com {  module sun {  module star {  module task {
  29 /** this service is kind of storage that allows to store passwords
  30     and to retrieve already stored.
  31
  32     <p>
  33     A password can be stored for the session period or persistently.
  34     The persistent way is only possible if configuration allows to use storage.
  35     It stores passwords encrypted with a super password. An interaction
  36     is used to ask a user for a super password.
  37     To allow such an interaction, an object that implements XInteractionHandler
  38     interface should be provided. For this purpose InteractionHandler
  39     service can be used.
  40     </p>
  41
  42     <p>
  43     In case no interaction handler is provided all passwords are stored
  44     for the session period. In case an interaction handler is provided, but
  45     the super password interaction does not return super password ( for any reason ),
  46     NoMasterException exception is thrown to let user use
  47     non-persistent way explicitly.
  48     </p>
  49 */
  50 published service PasswordContainer : com::sun::star::task::XPasswordContainer2;
  51
  52 }; }; }; };
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */