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