offapi/com/sun/star/ucb/AuthenticationRequest.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 ucb {
  23
  24 /** An error specifying lack of correct authentication data (e.g., to log into
  25     an account).
  26 */
  27 published exception AuthenticationRequest: com::sun::star::task::ClassifiedInteractionRequest
  28 {
  29     /** The name of the server (if applicable).
  30      */
  31     string ServerName;
  32
  33     /** Any diagnostic message about the failure to log in (if applicable; it
  34         will typically be an English phrase or sentence).
  35      */
  36     string Diagnostic;
  37
  38     /** Specifies if the authentication involves a "realm" (as can be the case
  39         for HTTP).
  40      */
  41     boolean HasRealm;
  42
  43     /** Any already specified realm.
  44
  45         If HasRealm is false, this member should be ignored.
  46      */
  47     string Realm;
  48
  49     /** Specifies if the authentication involves a "user name" (as is almost
  50         always the case).
  51     */
  52     boolean HasUserName;
  53
  54     /** Any already specified user name.
  55
  56         If HasUserName is false, this member should be ignored.
  57      */
  58     string UserName;
  59
  60     /** Specifies if the authentication involves a "password" (as is almost
  61         always the case).
  62     */
  63     boolean HasPassword;
  64
  65     /** Any already specified password.
  66
  67         If HasPassword is false, this member should be ignored.
  68      */
  69     string Password;
  70
  71     /** Specifies if the authentication involves an "account" (as can be the
  72         case for FTP).
  73     */
  74     boolean HasAccount;
  75
  76     /** Any already specified account.
  77
  78         If HasAccount is false, this member should be ignored.
  79      */
  80     string Account;
  81
  82 };
  83
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */