include/ucbhelper/simplecertificatevalidationrequest.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  * 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  */
  19
  20 #ifndef INCLUDED_UCBHELPER_SIMPLECERTIFICATEVALIDATIONREQUEST_HXX
  21 #define INCLUDED_UCBHELPER_SIMPLECERTIFICATEVALIDATIONREQUEST_HXX
  22
  23 #include <ucbhelper/interactionrequest.hxx>
  24 #include <ucbhelper/ucbhelperdllapi.h>
  25
  26 namespace com { namespace sun { namespace star { namespace uno { template <class interface_type> class Reference; } } } }
  27 namespace com { namespace sun { namespace star { namespace security { class XCertificate; } } } }
  28
  29
  30 namespace ucbhelper {
  31
  32 /**
  33   * This class implements a simple validation interaction request of a certificate.
  34   * Instances can be passed directly to XInteractionHandler::handle(...). Each
  35   * instance contains a CertificateValidationRequest and two interaction
  36   * continuations: "Abort" and "Approved". The parameters
  37   * for the CertificateValidationRequest object are partly taken from constructors parameters and partly defaulted
  38   * as follows:
  39   *
  40   * Read-write values: certificateValidity, certificate
  41   *
  42   * @see css::ucb::CertificateValidationRequest
  43   * @see InteractionApproved
  44   * @see InteractionRetry
  45   */
  46 class UCBHELPER_DLLPUBLIC SimpleCertificateValidationRequest final : public ucbhelper::InteractionRequest
  47 {
  48 public:
  49     /**
  50       * Constructor.
  51       *
  52       * @param lCertificateValidity contains a bitmask which validation error occur.
  53       * @param pCertificate contains the server certificate.
  54       */
  55     SimpleCertificateValidationRequest( sal_Int32 lCertificateValidity,
  56         const css::uno::Reference<css::security::XCertificate>& certificate,
  57         const OUString & hostname );
  58 };
  59
  60 } // namespace ucbhelper
  61
  62 #endif /* ! INCLUDED_UCBHELPER_SIMPLECERTIFICATEVALIDATIONREQUEST_HXX */
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */