1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_AuthenticationRequest_idl__
24#define __com_sun_star_ucb_AuthenticationRequest_idl__
25
26#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
27#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
28#endif
29
30
31//=============================================================================
32
33module com { module sun { module star { module ucb {
34
35//=============================================================================
36/** An error specifing lack of correct authentication data (e.g., to log into
37	an account).
38*/
39published exception AuthenticationRequest: com::sun::star::task::ClassifiedInteractionRequest
40{
41	//-------------------------------------------------------------------------
42	/** The name of the server (if applicable).
43	 */
44	string ServerName;
45
46	//-------------------------------------------------------------------------
47	/** Any diagnostic message about the failure to log in (if applicable; it
48		will typically be an english phrase or sentence).
49	 */
50	string Diagnostic;
51
52	//-------------------------------------------------------------------------
53	/** Specifies if the authentication involves a 'realm' (as can be the case
54		for HTTP).
55	 */
56	boolean HasRealm;
57
58	//-------------------------------------------------------------------------
59	/** Any already specified realm.
60
61		If HasRealm is false, this member should be ignored.
62	 */
63	string Realm;
64
65	//-------------------------------------------------------------------------
66	/** Specifies if the authentication involves a 'user name' (as is almost
67		always the case).
68	*/
69	boolean HasUserName;
70
71	//-------------------------------------------------------------------------
72	/** Any already specified user name.
73
74		If HasUserName is false, this member should be ignored.
75	 */
76	string UserName;
77
78	//-------------------------------------------------------------------------
79	/** Specifies if the authentication involves a 'password' (as is almost
80		always the case).
81	*/
82	boolean HasPassword;
83
84	//-------------------------------------------------------------------------
85	/** Any already specified password.
86
87		If HasPassword is false, this member should be ignored.
88	 */
89	string Password;
90
91	//-------------------------------------------------------------------------
92	/** Specifies if the authentication involves an 'account' (as can be the
93		case for FTP).
94	*/
95	boolean HasAccount;
96
97	//-------------------------------------------------------------------------
98	/** Any already specified account.
99
100		If HasAccount is false, this member should be ignored.
101	 */
102	string Account;
103
104};
105
106//=============================================================================
107
108}; }; }; };
109
110#endif
111