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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
/*************************************************************************
*
* $RCSfile: providerimpl.hxx,v $
*
* $Revision: 1.11 $
*
* last change: $Author: jb $ $Date: 2002-10-28 14:41:43 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_API_PROVIDERIMPL_HXX_
#define CONFIGMGR_API_PROVIDERIMPL_HXX_
#ifndef CONFIGMGR_TREEPROVIDER_HXX
#include "treeprovider.hxx"
#endif
#ifndef CONFIGMGR_DEFAULTPROVIDER_HXX
#include "defaultprovider.hxx"
#endif
#ifndef CONFIGMGR_MISC_OPTIONS_HXX_
#include "options.hxx"
#endif
#ifndef _COM_SUN_STAR_SCRIPT_XTYPECONVERTER_HPP_
#include <com/sun/star/script/XTypeConverter.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XEVENTLISTENER_HPP_
#include <com/sun/star/lang/XEventListener.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XCOMPONENT_HPP_
#include <com/sun/star/lang/XComponent.hpp>
#endif
#ifndef _CPPUHELPER_IMPLBASE1_HXX_
#include <cppuhelper/implbase1.hxx>
#endif
#ifndef _OSL_MUTEX_HXX_
#include <osl/mutex.hxx>
#endif
namespace com { namespace sun { namespace star {
namespace uno
{
class Any;
class XInterface;
template <class> class Sequence;
template <class> class Reference;
}
namespace beans
{
struct PropertyValue;
}
} } }
namespace rtl
{
class OUString;
template <class RCType> class Reference;
}
namespace configmgr
{
namespace css = ::com::sun::star;
namespace uno = css::uno;
namespace script = css::script;
namespace lang = css::lang;
namespace beans = css::beans;
using ::rtl::OUString;
class ISubtree;
class ITemplateManager;
class IConfigDefaultProvider;
class IConfigSession;
class TreeManager;
class ConnectionSettings;
struct IConfigBroadcaster;
namespace configapi
{
class NodeElement;
class ApiProviderInstances;
class Factory;
}
// -----------------------------------------------------------------------------
class OProviderImpl : public ITreeManager, public IDefaultableTreeManager, public IInterface
{
friend class OProvider;
OProvider* m_pProvider; /// used for ref counting, uno representation
public:
//==========================================================================
//= FactoryArguments
//==========================================================================
/** Helper class for evaluation of the arguments for creating a service instance.*/
struct FactoryArguments
{
/// possible arguments, given only in small letters.
enum Argument
{
ARG_NODEPATH, // requested node path
ARG_DEPTH, // depth of the tree
ARG_USER, // name of the user - only for admin
ARG_LOCALE, // desired locale
ARG_NOCACHE, // cache disabling
ARG_ASYNC, // lasy write data
_arg_count,
ARG_NOT_FOUND = _arg_count
};
static sal_Char const * const asciiArgumentNames[];
static OUString getArgumentName(Argument _which) CFG_NOTHROW();
static Argument lookupArgument(OUString const& sArgumentName) CFG_NOTHROW();
static OUString getUserArgumentName() CFG_NOTHROW() { return getArgumentName(ARG_USER); }
static OUString getNodePathArgumentName() CFG_NOTHROW() { return getArgumentName(ARG_NODEPATH); }
static OUString getDepthArgumentNameArgumentName() CFG_NOTHROW() { return getArgumentName(ARG_DEPTH); }
static OUString getLocaleArgumentName() CFG_NOTHROW() { return getArgumentName(ARG_LOCALE); }
static OUString getNoCacheArgumentName() CFG_NOTHROW() { return getArgumentName(ARG_NOCACHE); }
static OUString getAsyncArgumentName() CFG_NOTHROW() { return getArgumentName(ARG_ASYNC); }
public:
/** extracts arguments from the argument sequence into to the parameter variables
<p>unknown arguments are ignored</p>
@throws com::sun::star::lang::IllegalArgumentException
if an element of _rArgs had the wrong type or
if the value of a known argument has the wrong type or
if the value of a known argument is out of range (sometimes)
or if no non-empty node path argument could be extracted,
*/
static void extractArgs( const uno::Sequence<uno::Any>& _rArgs,
OUString& /* [out] */ _rNodeAccessor,
sal_Int32& /* [out] */ _nLevels,
vos::ORef<OOptions> /* [in/out] */ xOptions
) CFG_THROW1(lang::IllegalArgumentException);
static bool extractOneArgument( OUString const& aName, uno::Any const& aValue,
OUString& /* [out] */ _rNodeAccessor,
sal_Int32& /* [out] */ _nLevels,
vos::ORef<OOptions> /* [in/out] */ _xOptions
) CFG_NOTHROW();
};
private:
typedef uno::Reference< lang::XMultiServiceFactory > CreationContext;
typedef uno::Reference< script::XTypeConverter > TypeConverterRef;
CreationContext m_xContext;
TypeConverterRef m_xTypeConverter;
vos::ORef<OOptions> m_xDefaultOptions;
configapi::ApiProviderInstances* m_pNewProviders; /// order depedency - this must be after the TreeManager
mutable osl::Mutex m_aTreeManagerMutex;
TreeManager* m_pTreeManager; /// the tree cache. Will hold a reference to us as long as it life
IConfigSession* m_pSession;
rtl::Reference< TreeManager > maybeGetTreeManager() const CFG_NOTHROW();
rtl::Reference< TreeManager > getTreeManager() const CFG_UNO_THROW_RTE();
void setTreeManager(TreeManager * pTreeManager) CFG_UNO_THROW_RTE();
void clearTreeManager() CFG_NOTHROW();
protected:
IConfigSession* getSession() const;
public:
OProviderImpl(OProvider* _pProvider, CreationContext const & _xContext);
virtual ~OProviderImpl();
/// ITreeManager
virtual memory::Segment* getDataSegment(AbsolutePath const& _rAccessor, const vos::ORef < OOptions >& _xOptions);
virtual data::NodeAccess requestSubtree(AbsolutePath const& aSubtreePath, const vos::ORef < OOptions >& _xOptions,
sal_Int16 nMinLevels = ALL_LEVELS) CFG_UNO_THROW_ALL( );
virtual void updateTree(memory::UpdateAccessor& _aAccessToken, TreeChangeList& aChanges) CFG_UNO_THROW_ALL( );
virtual void releaseSubtree( AbsolutePath const& aSubtreePath, const vos::ORef < OOptions >& _xOptions ) CFG_NOTHROW();
virtual void saveAndNotifyUpdate(memory::Accessor const& _aChangedDataAccessor, TreeChangeList const& aChanges) CFG_UNO_THROW_ALL( );
virtual void disposeData(const vos::ORef < OOptions >& _xOptions) CFG_NOTHROW();
virtual void fetchSubtree(AbsolutePath const& aSubtreePath, const vos::ORef < OOptions >& _xOptions, sal_Int16 nMinLevels = ALL_LEVELS) CFG_NOTHROW();
/// IDefaultableTreeManager
virtual sal_Bool fetchDefaultData( memory::UpdateAccessor& _aAccessToken,
AbsolutePath const& aSubtreePath, const vos::ORef < OOptions >& _xOptions,
sal_Int16 nMinLevels) CFG_UNO_THROW_ALL( );
// IInterface
virtual void SAL_CALL acquire( ) throw ();
virtual void SAL_CALL release( ) throw ();
// DefaultProvider access
rtl::Reference< IConfigDefaultProvider > getDefaultProvider() const CFG_UNO_THROW_RTE( );
// TemplateManager access
rtl::Reference< IConfigTemplateManager > getTemplateProvider() const CFG_UNO_THROW_RTE( );
protected:
static OUString getErrorMessage(AbsolutePath const& _rAccessor, const vos::ORef < OOptions >& _xOptions);
virtual void SAL_CALL dispose() throw();
public:
const OOptions& getDefaultOptions() const {return *m_xDefaultOptions;}
TypeConverterRef getTypeConverter() const {return m_xTypeConverter;}
configapi::Factory& getWriterFactory();
IConfigBroadcaster* getNotifier() CFG_NOTHROW();
uno::XInterface* getProviderInstance();
// actual factory methods
// the returned object (if any) has to be acquired once)
configapi::NodeElement* buildReadAccess( OUString const& _rAccessor, const vos::ORef < OOptions >& _xOptions, sal_Int32 nMinLevels) CFG_UNO_THROW_ALL( );
// the returned object (if any) has to be acquired once)
configapi::NodeElement* buildUpdateAccess(OUString const& _rAccessor, const vos::ORef < OOptions >& _xOptions, sal_Int32 nMinLevels) CFG_UNO_THROW_ALL( );
private:
bool initSession(const ConnectionSettings& _rSettings);
private:
void implInitFromSettings(const ConnectionSettings& _rSettings, bool& rNeedProfile);
void implInitFromProfile(data::NodeAccess const& aProfile);
virtual void initFromSettings(const ConnectionSettings& _rSettings, bool& rNeedProfile);
virtual void initFromProfile(data::NodeAccess const& aProfile);
};
} // namespace configmgr
#endif // CONFIGMGR_API_PROVIDERIMPL_HXX_
|
