include/ucbhelper/authenticationfallback.hxx

   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
  10 #ifndef INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX
  11 #define INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX
  12
  13 #include <rtl/ref.hxx>
  14 #include <ucbhelper/interactionrequest.hxx>
  15 #include <ucbhelper/ucbhelperdllapi.h>
  16 #include <com/sun/star/ucb/AuthenticationFallbackRequest.hpp>
  17
  18
  19 namespace ucbhelper {
  20
  21 /**
  22   * This class implements a simple authentication interaction request used
  23   * when programmatically authentication cannot succeed.
  24   *
  25   * Read-only values : instructions, url
  26   * Read-write values: code
  27   */
  28 class UCBHELPER_DLLPUBLIC AuthenticationFallbackRequest : public ucbhelper::InteractionRequest
  29 {
  30 private:
  31     rtl::Reference< ucbhelper::InteractionAuthFallback > m_xAuthFallback;
  32
  33 public:
  34     /**
  35       * Constructor.
  36       *
  37       * @param rInstructions instructions to be followed by the user
  38       * @param rURL contains a URL for which authentication is requested.
  39       */
  40     AuthenticationFallbackRequest( const OUString & rInstructions,
  41                                  const OUString & rURL );
  42
  43     const rtl::Reference< ucbhelper::InteractionAuthFallback >&
  44         getAuthFallbackInter( ) const { return m_xAuthFallback; }
  45
  46 };
  47
  48 } // namespace ucbhelper
  49
  50 #endif /* ! INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX*/
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */