offapi/com/sun/star/ucb/AuthenticationRequest.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_ucb_AuthenticationRequest_idl__
  28 #define __com_sun_star_ucb_AuthenticationRequest_idl__
  29
  30 #ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
  31 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module ucb {
  38
  39 //=============================================================================
  40 /** An error specifing lack of correct authentication data (e.g., to log into
  41     an account).
  42 */
  43 published exception AuthenticationRequest: com::sun::star::task::ClassifiedInteractionRequest
  44 {
  45     //-------------------------------------------------------------------------
  46     /** The name of the server (if applicable).
  47      */
  48     string ServerName;
  49
  50     //-------------------------------------------------------------------------
  51     /** Any diagnostic message about the failure to log in (if applicable; it
  52         will typically be an english phrase or sentence).
  53      */
  54     string Diagnostic;
  55
  56     //-------------------------------------------------------------------------
  57     /** Specifies if the authentication involves a 'realm' (as can be the case
  58         for HTTP).
  59      */
  60     boolean HasRealm;
  61
  62     //-------------------------------------------------------------------------
  63     /** Any already specified realm.
  64
  65         If HasRealm is false, this member should be ignored.
  66      */
  67     string Realm;
  68
  69     //-------------------------------------------------------------------------
  70     /** Specifies if the authentication involves a 'user name' (as is almost
  71         always the case).
  72     */
  73     boolean HasUserName;
  74
  75     //-------------------------------------------------------------------------
  76     /** Any already specified user name.
  77
  78         If HasUserName is false, this member should be ignored.
  79      */
  80     string UserName;
  81
  82     //-------------------------------------------------------------------------
  83     /** Specifies if the authentication involves a 'password' (as is almost
  84         always the case).
  85     */
  86     boolean HasPassword;
  87
  88     //-------------------------------------------------------------------------
  89     /** Any already specified password.
  90
  91         If HasPassword is false, this member should be ignored.
  92      */
  93     string Password;
  94
  95     //-------------------------------------------------------------------------
  96     /** Specifies if the authentication involves an 'account' (as can be the
  97         case for FTP).
  98     */
  99     boolean HasAccount;
 100
 101     //-------------------------------------------------------------------------
 102     /** Any already specified account.
 103
 104         If HasAccount is false, this member should be ignored.
 105      */
 106     string Account;
 107
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114 #endif