| blob | 6de19931238c27eb86a22a5a47797e64ab307474 |
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 */
20 #ifndef _UCBHELPER_INTERATIONREQUEST_HXX
21 #define _UCBHELPER_INTERATIONREQUEST_HXX
23 #include <com/sun/star/lang/XTypeProvider.hpp>
24 #include <com/sun/star/task/XInteractionRequest.hpp>
25 #include <com/sun/star/task/XInteractionAbort.hpp>
26 #include <com/sun/star/task/XInteractionRetry.hpp>
27 #include <com/sun/star/task/XInteractionApprove.hpp>
28 #include <com/sun/star/task/XInteractionDisapprove.hpp>
29 #include <com/sun/star/ucb/XInteractionReplaceExistingData.hpp>
30 #include <com/sun/star/ucb/XInteractionSupplyAuthentication2.hpp>
31 #include <com/sun/star/ucb/XInteractionSupplyName.hpp>
32 #include <rtl/ref.hxx>
33 #include <cppuhelper/weak.hxx>
40 //============================================================================
43 /**
44 * This class implements the interface XInteractionRequest. Instances can
45 * be passed directly to XInteractionHandler::handle(...). Each interaction
46 * request contains an exception describing the error and a number of
47 * interaction continuations describing the possible "answers" for the request.
48 * After the request was passed to XInteractionHandler::handle(...) the method
49 * getSelection() returns the continuation choosen by the interaction handler.
50 *
51 * The typical usage of this class would be:
52 *
53 * 1) Create exception object that shall be handled by the interaction handler.
54 * 2) Create InteractionRequest, supply exception as ctor parameter
55 * 3) Create continuations needed and add them to a sequence
56 * 4) Supply the continuations to the InteractionRequest by calling
57 * setContinuations(...)
58 *
59 * This class can also be used as base class for more specialized requests,
60 * like authentication requests.
61 */
65 {
75 /**
76 * Constructor.
77 *
78 * @param rRequest is the exception describing the error.
79 */
82 /**
83 * This method sets the continuations for the request.
84 *
85 * @param rContinuations contains the possible continuations.
86 */
91 rContinuations );
93 // XInterface
102 // XTypeProvider
110 // XInteractionRequest
120 // Non-interface methods.
122 /**
123 * After passing this request to XInteractionHandler::handle, this method
124 * returns the continuation that was choosen by the interaction handler.
125 *
126 * @return the continuation choosen by an interaction handler or an empty
127 * reference, if the request was not (yet) handled.
128 */
131 /**
132 * This method sets a continuation for the request. It also can be used
133 * to reset the continuation set by a previous XInteractionHandler::handle
134 * call in order to use this request object more then once.
135 *
136 * @param rxSelection is the interaction continuation to activate for
137 * the request or an empty reference in order to reset the
138 * current selection.
139 */
140 void
143 };
145 //============================================================================
148 /**
149 * This class is the base for implementations of the interface
150 * XInteractionContinuation. Classes derived from this bas class work together
151 * with class InteractionRequest.
152 *
153 * Derived classes must implement their XInteractionContinuation::select()
154 * method the way that they simply call recordSelection() which is provided by
155 * this class.
156 */
158 {
162 /**
163 * This method marks this continuation as "selected" at the request it
164 * belongs to.
165 *
166 * Derived classes must implement their XInteractionContinuation::select()
167 * method the way that they call this method.
168 */
174 };
176 //============================================================================
177 /**
178 * This class implements a standard interaction continuation, namely the
179 * interface XInteractionAbort. Instances of this class can be passed
180 * along with an interaction request to indicate the possiblity to abort
181 * the operation that caused the request.
182 */
186 {
191 // XInterface
200 // XTypeProvider
208 // XInteractionContinuation
211 };
213 //============================================================================
214 /**
215 * This class implements a standard interaction continuation, namely the
216 * interface XInteractionRetry. Instances of this class can be passed
217 * along with an interaction request to indicate the possiblity to retry
218 * the operation that caused the request.
219 */
223 {
228 // XInterface
237 // XTypeProvider
245 // XInteractionContinuation
248 };
250 //============================================================================
251 /**
252 * This class implements a standard interaction continuation, namely the
253 * interface XInteractionApprove. Instances of this class can be passed
254 * along with an interaction request to indicate the possiblity to approve
255 * the request.
256 */
260 {
265 // XInterface
274 // XTypeProvider
282 // XInteractionContinuation
285 };
287 //============================================================================
288 /**
289 * This class implements a standard interaction continuation, namely the
290 * interface XInteractionDisapprove. Instances of this class can be passed
291 * along with an interaction request to indicate the possiblity to disapprove
292 * the request.
293 */
297 {
302 // XInterface
311 // XTypeProvider
319 // XInteractionContinuation
322 };
324 //============================================================================
325 /**
326 * This class implements a standard interaction continuation, namely the
327 * interface XInteractionSupplyAuthentication. Instances of this class can be
328 * passed along with an authentication interaction request to enable the
329 * interaction handler to supply the missing authentication data.
330 */
335 {
337 m_aRememberPasswordModes;
339 m_aRememberAccountModes;
340 OUString m_aRealm;
341 OUString m_aUserName;
342 OUString m_aPassword;
343 OUString m_aAccount;
357 /**
358 * Constructor.
359 *
360 * @param rxRequest is the interaction request that owns this continuation.
361 * @param bCanSetRealm indicates, whether the realm given with the
362 * authentication request is read-only.
363 * @param bCanSetUserName indicates, whether the username given with the
364 * authentication request is read-only.
365 * @param bCanSetPassword indicates, whether the password given with the
366 * authentication request is read-only.
367 * @param bCanSetAccount indicates, whether the account given with the
368 * authentication request is read-only.
369 *
370 * @see com::sun::star::ucb::AuthenticationRequest
371 */
374 sal_Bool bCanSetRealm,
375 sal_Bool bCanSetUserName,
376 sal_Bool bCanSetPassword,
377 sal_Bool bCanSetAccount);
378 /**
379 * Constructor.
380 *
381 * Note: The remember-authentication stuff is interesting only for
382 * clients implementing own password storage functionality.
383 *
384 * @param rxRequest is the interaction request that owns this continuation.
385 * @param bCanSetRealm indicates, whether the realm given with the
386 * authentication request is read-only.
387 * @param bCanSetUserName indicates, whether the username given with the
388 * authentication request is read-only.
389 * @param bCanSetPassword indicates, whether the password given with the
390 * authentication request is read-only.
391 * @param bCanSetAccount indicates, whether the account given with the
392 * authentication request is read-only.
393 * @param rRememberPasswordModes specifies the authentication-remember-
394 * modes for passwords supported by the requesting client.
395 * @param eDefaultRememberPasswordMode specifies the default
396 * authentication-remember-mode for passwords preferred by the
397 * requesting client.
398 * @param rRememberAccountModes specifies the authentication-remember-
399 * modes for accounts supported by the requesting client.
400 * @param eDefaultRememberAccountMode specifies the default
401 * authentication-remember-mode for accounts preferred by the
402 * requesting client.
403 * @param bCanUseSystemCredentials indicates whether issuer of the
404 * authetication request can obtain and use system credentials
405 * for authentication.
406 * @param bDefaultUseSystemCredentials specifies the default system
407 * credentials usage preferred by the requesting client
408 *
409 * @see com::sun::star::ucb::AuthenticationRequest
410 * @see com::sun::star::ucb::RememberAuthentication
411 */
414 sal_Bool bCanSetRealm,
415 sal_Bool bCanSetUserName,
416 sal_Bool bCanSetPassword,
417 sal_Bool bCanSetAccount,
420 rRememberPasswordModes,
422 eDefaultRememberPasswordMode,
425 rRememberAccountModes,
427 eDefaultRememberAccountMode,
428 sal_Bool bCanUseSystemCredentials,
429 sal_Bool bDefaultUseSystemCredentials );
431 // XInterface
440 // XTypeProvider
448 // XInteractionContinuation
452 // XInteractionSupplyAuthentication
453 virtual sal_Bool SAL_CALL
460 virtual sal_Bool SAL_CALL
467 virtual sal_Bool SAL_CALL
483 virtual sal_Bool SAL_CALL
499 // XInteractionSupplyAuthentication2
505 // Non-interface methods.
507 /**
508 * This method returns the realm that was supplied by the interaction
509 * handler.
510 *
511 * @return the realm.
512 */
515 /**
516 * This method returns the username that was supplied by the interaction
517 * handler.
518 *
519 * @return the username.
520 */
523 /**
524 * This method returns the password that was supplied by the interaction
525 * handler.
526 *
527 * @return the password.
528 */
531 /**
532 * This method returns the account that was supplied by the interaction
533 * handler.
534 *
535 * @return the account.
536 */
539 /**
540 * This method returns the authentication remember-mode for the password
541 * that was supplied by the interaction handler.
542 *
543 * @return the remember-mode for the password.
544 */
548 /**
549 * This method returns the authentication remember-mode for the account
550 * that was supplied by the interaction handler.
551 *
552 * @return the remember-mode for the account.
553 */
558 };
560 //============================================================================
563 sal_Bool bCanSetRealm,
564 sal_Bool bCanSetUserName,
565 sal_Bool bCanSetPassword,
566 sal_Bool bCanSetAccount )
585 {
590 }
592 //============================================================================
595 sal_Bool bCanSetRealm,
596 sal_Bool bCanSetUserName,
597 sal_Bool bCanSetPassword,
598 sal_Bool bCanSetAccount,
602 eDefaultRememberPasswordMode,
606 eDefaultRememberAccountMode,
607 sal_Bool bCanUseSystemCredentials,
608 sal_Bool bDefaultUseSystemCredentials )
623 {
624 }
626 //============================================================================
627 /**
628 * This class implements a standard interaction continuation, namely the
629 * interface XInteractionSupplyName. Instances of this class can be passed
630 * along with an interaction request to indicate the possiblity to
631 * supply a new name.
632 */
636 {
637 OUString m_aName;
643 // XInterface
652 // XTypeProvider
660 // XInteractionContinuation
664 // XInteractionSupplyName
668 // Non-interface methods.
670 /**
671 * This method returns the name that was supplied by the interaction
672 * handler.
673 *
674 * @return the name.
675 */
677 };
679 //============================================================================
680 /**
681 * This class implements a standard interaction continuation, namely the
682 * interface XInteractionReplaceExistingData. Instances of this class can be
683 * passed along with an interaction request to indicate the possiblity to
684 * replace existing data.
685 */
690 {
695 // XInterface
704 // XTypeProvider
712 // XInteractionContinuation
715 };
721 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */