offapi/com/sun/star/ucb/AuthenticationRequest.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AuthenticationRequest.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_AuthenticationRequest_idl__
  31 #define __com_sun_star_ucb_AuthenticationRequest_idl__
  32
  33 #ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
  34 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** An error specifing lack of correct authentication data (e.g., to log into
  44     an account).
  45 */
  46 published exception AuthenticationRequest: com::sun::star::task::ClassifiedInteractionRequest
  47 {
  48     //-------------------------------------------------------------------------
  49     /** The name of the server (if applicable).
  50      */
  51     string ServerName;
  52
  53     //-------------------------------------------------------------------------
  54     /** Any diagnostic message about the failure to log in (if applicable; it
  55         will typically be an english phrase or sentence).
  56      */
  57     string Diagnostic;
  58
  59     //-------------------------------------------------------------------------
  60     /** Specifies if the authentication involves a 'realm' (as can be the case
  61         for HTTP).
  62      */
  63     boolean HasRealm;
  64
  65     //-------------------------------------------------------------------------
  66     /** Any already specified realm.
  67
  68         If HasRealm is false, this member should be ignored.
  69      */
  70     string Realm;
  71
  72     //-------------------------------------------------------------------------
  73     /** Specifies if the authentication involves a 'user name' (as is almost
  74         always the case).
  75     */
  76     boolean HasUserName;
  77
  78     //-------------------------------------------------------------------------
  79     /** Any already specified user name.
  80
  81         If HasUserName is false, this member should be ignored.
  82      */
  83     string UserName;
  84
  85     //-------------------------------------------------------------------------
  86     /** Specifies if the authentication involves a 'password' (as is almost
  87         always the case).
  88     */
  89     boolean HasPassword;
  90
  91     //-------------------------------------------------------------------------
  92     /** Any already specified password.
  93
  94         If HasPassword is false, this member should be ignored.
  95      */
  96     string Password;
  97
  98     //-------------------------------------------------------------------------
  99     /** Specifies if the authentication involves an 'account' (as can be the
 100         case for FTP).
 101     */
 102     boolean HasAccount;
 103
 104     //-------------------------------------------------------------------------
 105     /** Any already specified account.
 106
 107         If HasAccount is false, this member should be ignored.
 108      */
 109     string Account;
 110
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 #endif