1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _UCBHELPER_SIMPLEAUTHENTICATIONREQUEST_HXX
#define _UCBHELPER_SIMPLEAUTHENTICATIONREQUEST_HXX
#include <rtl/ref.hxx>
#include <ucbhelper/interactionrequest.hxx>
#include "ucbhelper/ucbhelperdllapi.h"
namespace com { namespace sun { namespace star { namespace ucb {
class URLAuthenticationRequest;
} } } }
namespace ucbhelper {
/**
* This class implements a simple authentication interaction request.
* Instances can be passed directly to XInteractionHandler::handle(...). Each
* instance contains an AuthenticationRequest and three interaction
* continuations: "Abort", "Retry" and "SupplyAuthentication". The parameters
* for the AuthenticationRequest and the InteractionSupplyAuthentication
* objects are partly taken from contructors parameters and partly defaulted
* as follows:
*
* Read-only values : servername, realm
* Read-write values: username, password, account
* All remember-authentication values: RememberAuthentication_NO
*
* @see com::sun::star::ucb::AuthenticationRequest
* @see com::sun::star::ucb::RememberAuthentication
* @see InteractionAbort
* @see InteractionRetry
* @see InteractionSupplyAuthentication
*/
class UCBHELPER_DLLPUBLIC SimpleAuthenticationRequest : public ucbhelper::InteractionRequest
{
rtl::Reference<
ucbhelper::InteractionSupplyAuthentication > m_xAuthSupplier;
private:
void initialize( const ::com::sun::star::ucb::URLAuthenticationRequest & rRequest,
sal_Bool bCanSetRealm,
sal_Bool bCanSetUserName,
sal_Bool bCanSetPassword,
sal_Bool bCanSetAccount,
sal_Bool bAllowPersistentStoring,
sal_Bool bAllowUseSystemCredentials );
public:
/** Specification whether some entity (realm, username, password, account)
is either not applicable at all, has a fixed value, or is modifiable.
*/
enum EntityType
{
ENTITY_NA,
ENTITY_FIXED,
ENTITY_MODIFY
};
/**
* Constructor.
*
* @param rURL contains a URL for which authentication is requested.
* @param rServerName contains a server name.
* @param rRealm contains a realm, if applicable.
* @param rUserName contains a username, if available (for instance from
* a previous try).
* @param rPassword contains a password, if available (for instance from
* a previous try).
* @param rAccount contains an account, if applicable.
*/
SimpleAuthenticationRequest( const rtl::OUString & rURL,
const rtl::OUString & rServerName,
const rtl::OUString & rRealm,
const rtl::OUString & rUserName,
const rtl::OUString & rPassword,
const rtl::OUString & rAccount
= rtl::OUString() );
/**
* Constructor.
*
* @param rURL contains a URL for which authentication is requested.
* @param rServerName contains a server name.
* @param rRealm contains a realm, if applicable.
* @param rUserName contains a username, if available (for instance from
* a previous try).
* @param rPassword contains a password, if available (for instance from
* a previous try).
* @param rAccount contains an account, if applicable.
* @param bAllowPersistentStoring specifies if the credentials should
* be stored in the passowrd container persistently
* @param bAllowUseSystemCredntials specifies if requesting client is
* able to obtain and use system credentials for authentication
*/
SimpleAuthenticationRequest( const rtl::OUString & rURL,
const rtl::OUString & rServerName,
const rtl::OUString & rRealm,
const rtl::OUString & rUserName,
const rtl::OUString & rPassword,
const rtl::OUString & rAccount,
sal_Bool bAllowPersistentStoring,
sal_Bool bAllowUseSystemCredentials );
/**
* Constructor.
*
* @param rServerName contains a server name.
* @param eRealmType specifies whether a realm is applicable and
modifiable.
* @param rRealm contains a realm, if applicable.
* @param eUserNameType specifies whether a username is applicable and
modifiable.
* @param rUserName contains a username, if available (for instance from
* a previous try).
* @param ePasswordType specifies whether a password is applicable and
modifiable.
* @param rPassword contains a password, if available (for instance from
* a previous try).
* @param eAccountType specifies whether an account is applicable and
modifiable.
* @param rAccount contains an account, if applicable.
*/
SimpleAuthenticationRequest( const rtl::OUString & rURL,
const rtl::OUString & rServerName,
EntityType eRealmType,
const rtl::OUString & rRealm,
EntityType eUserNameType,
const rtl::OUString & rUserName,
EntityType ePasswordType,
const rtl::OUString & rPassword,
EntityType eAccountType = ENTITY_NA,
const rtl::OUString & rAccount
= rtl::OUString() );
/**
* Constructor.
*
* @param rURL contains a URL for which authentication is requested.
* @param rServerName contains a server name.
* @param eRealmType specifies whether a realm is applicable and
modifiable.
* @param rRealm contains a realm, if applicable.
* @param eUserNameType specifies whether a username is applicable and
modifiable.
* @param rUserName contains a username, if available (for instance from
* a previous try).
* @param ePasswordType specifies whether a password is applicable and
modifiable.
* @param rPassword contains a password, if available (for instance from
* a previous try).
* @param eAccountType specifies whether an account is applicable and
modifiable.
* @param rAccount contains an account, if applicable.
* @param bAllowPersistentStoring specifies if the credentials should
* be stored in the passowrd container persistently
* @param bAllowUseSystemCredntials specifies if requesting client is
* able to obtain and use system credentials for authentication
*/
SimpleAuthenticationRequest( const rtl::OUString & rURL,
const rtl::OUString & rServerName,
EntityType eRealmType,
const rtl::OUString & rRealm,
EntityType eUserNameType,
const rtl::OUString & rUserName,
EntityType ePasswordType,
const rtl::OUString & rPassword,
EntityType eAccountType,
const rtl::OUString & rAccount,
sal_Bool bAllowPersistentStoring,
sal_Bool bAllowUseSystemCredentials );
/**
* This method returns the supplier for the missing authentication data,
* that, for instance can be used to query the password supplied by the
* interaction handler.
*
* @return the supplier for the missing authentication data.
*/
const rtl::Reference< ucbhelper::InteractionSupplyAuthentication > &
getAuthenticationSupplier() const { return m_xAuthSupplier; }
};
} // namespace ucbhelper
#endif /* !_UCBHELPER_SIMPLEAUTHENTICATIONREQUEST_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
