offapi/com/sun/star/task/XPasswordContainer.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
  21
  22 module com { module sun { module star { module task {
  23
  24 /** Allows to save passwords with URL-pattern, to use them later.
  25 */
  26 published interface XPasswordContainer : com::sun::star::uno::XInterface
  27 {
  28     /** Save passwords into the container.
  29
  30         @param Url        URL-pattern, that will be used later to retrieve
  31         passwords.
  32
  33         @param UserName   The username.
  34
  35         @param Passwords  The password-list.
  36
  37         @param Handler    The handler to get super password to en/decrypt passwords
  38
  39
  40     */
  41     void   add( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler );
  42
  43     /** Save passwords into the container, and store them in the file.
  44
  45         @param Url        URL-pattern, that will be used later to retrieve
  46                           passwords.
  47
  48         @param UserName   The username.
  49
  50         @param Passwords  The password-list.
  51
  52         @param Handler    The handler to get super password to en/decrypt passwords
  53
  54
  55     */
  56     void   addPersistent( [in] string Url, [in] string UserName, [in] sequence<string> Passwords, [in] XInteractionHandler Handler );
  57
  58     /** Find users with passwords for the url pattern.
  59
  60         @param Url     URL-pattern to retrieve password for.
  61
  62         @param Handler    The handler to get super password to en/decrypt passwords
  63
  64         @returns       Best matched url-pattern with user-records list.
  65     */
  66     UrlRecord find( [in] string Url, [in] XInteractionHandler Handler );
  67
  68     /** Find passwords for the url pattern and username.
  69
  70         @param Url      URL-pattern to retrieve passwords for.
  71
  72         @param UserName Username to retrieve passwords for.
  73
  74         @param Handler    The handler to get super password to en/decrypt passwords
  75
  76         @returns        Best matched url-pattern for the username.
  77     */
  78     UrlRecord findForName( [in] string Url, [in] string UserName , [in] XInteractionHandler Handler );
  79
  80     /** Remove passwords for the url pattern and username.
  81
  82         @param Url      URL-pattern to remove passwords for.
  83
  84         @param UserName Username to remove passwords for.
  85
  86     */
  87     void remove( [in] string Url, [in] string UserName );
  88
  89
  90     /** Remove passwords for the url pattern and username from the file.
  91
  92         @param Url      URL-pattern to remove passwords for.
  93
  94         @param UserName Username to remove passwords for.
  95
  96     */
  97     void removePersistent( [in] string Url, [in] string UserName );
  98
  99     /** Clean the file.
 100     */
 101     void removeAllPersistent();
 102
 103     /** Get all records from the file.
 104
 105         @returns        List of url-records.
 106     */
 107     sequence<UrlRecord> getAllPersistent( [in] XInteractionHandler Handler );
 108
 109 };
 110
 111
 112 }; }; }; };
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */