pqServerConfigurationImporter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: $RCSfile$
5 
6  Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 ========================================================================*/
32 #ifndef pqServerConfigurationImporter_h
33 #define pqServerConfigurationImporter_h
34 
35 #include "pqComponentsModule.h"
36 #include "pqServerConfiguration.h"
37 #include <QList>
38 #include <QObject>
39 
40 class QAuthenticator;
41 class QNetworkReply;
42 class QUrl;
43 
49 {
50  Q_OBJECT
51  typedef QObject Superclass;
52 
53 public:
54  pqServerConfigurationImporter(QObject* parent = nullptr);
56 
58  {
59  PVSC
60  };
61 
77  void addSource(const QString& name, const QUrl& url, SourceMode mode = PVSC);
78 
82  void clearSources();
83 
84  class Item
85  {
86  public:
91 
96  QString SourceName;
97  };
98 
106  const QList<Item>& configurations() const;
107 
108 public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
117  void fetchConfigurations();
118 
123  void abortFetch();
124 
125 Q_SIGNALS:
131  void incrementalUpdate();
132 
136  void configurationsUpdated();
137 
143  void authenticationRequired(QNetworkReply*, QAuthenticator*);
144 
149  void abortFetchTriggered();
150 
155  void message(const QString& message);
156 
157 protected:
163  bool processDownloadedContents();
164 
169  bool fetch(const QUrl& url);
170 
171 private Q_SLOTS:
175  void readCurrentData();
176 
177 private: // NOLINT(readability-redundant-access-specifiers)
178  Q_DISABLE_COPY(pqServerConfigurationImporter)
179 
180  class pqInternals;
181  pqInternals* Internals;
182 };
183 
184 #endif
#define PQCOMPONENTS_EXPORT
QString SourceName
Refers to the user-friendly name for the source defined in the configurations file.
pqServerConfigurationImporter class can be used to import remote server configurations.
pqServerConfiguration corresponds to a server connection configuration.
pqServerConfiguration Configuration
Points to the server configuration.