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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_UCBHELPER_PROVIDERHELPER_HXX
#define INCLUDED_UCBHELPER_PROVIDERHELPER_HXX
#include <vector>
#include <memory>
#include <com/sun/star/ucb/XContentProvider.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <cppuhelper/implbase.hxx>
#include <rtl/ref.hxx>
#include <ucbhelper/ucbhelperdllapi.h>
namespace com::sun::star::ucb {
class XPropertySetRegistry;
class XPersistentPropertySet;
}
namespace com::sun::star::uno { class XComponentContext; }
namespace ucbhelper_impl { struct ContentProviderImplHelper_Impl; }
namespace ucbhelper {
class ContentImplHelper;
typedef rtl::Reference< ContentImplHelper > ContentImplHelperRef;
typedef std::vector< ContentImplHelperRef > ContentRefList;
/**
* This is an abstract base class for implementations of the service
* com.sun.star.ucb.ContentProvider. It provides contents derived from
* class ucb::ContentImplHelper.
*
* Features of the base class implementation:
* - standard interfaces ( XInterface, XTypeProvider, XServiceInfo )
* - maintains a set of ContentImplHelper objects, which were created by
* the provider implementation. So there will be exactly one object for
* one Content Identifier.
* - Provides access to the Additional Core PropertySet of a content.
* ( These set contains the properties added to a content using its
* XPropertyContainer interface )
*/
class UCBHELPER_DLLPUBLIC ContentProviderImplHelper :
public cppu::WeakImplHelper<
css::lang::XServiceInfo,
css::ucb::XContentProvider>
{
friend class ContentImplHelper;
std::unique_ptr<ucbhelper_impl::ContentProviderImplHelper_Impl> m_pImpl;
protected:
osl::Mutex m_aMutex;
css::uno::Reference< css::uno::XComponentContext > m_xContext;
private:
UCBHELPER_DLLPRIVATE void removeContent( ContentImplHelper* pContent );
UCBHELPER_DLLPRIVATE css::uno::Reference< css::ucb::XPropertySetRegistry >
getAdditionalPropertySetRegistry();
UCBHELPER_DLLPRIVATE void cleanupRegisteredContents();
protected:
/**
* This method returns a content with the given id, if it already exists.
* Use this method in your "queryContent" implementation to ensure unique
* objects.
*
* @param Identifier is the content identifier, for that an existing
* content object is requested.
* @return the content with the given identifier, if it exists or 0, if it
* does not exist.
*/
rtl::Reference< ContentImplHelper >
queryExistingContent( const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier );
/**
* This method returns a content with the given URL, if it already exists.
*
* @param rURL is the URL ( content identifier string ), for that an
* existing content object is requested.
* @return the content with the given URL, if it exists or 0, if it
* does not exist.
*/
rtl::Reference< ContentImplHelper >
queryExistingContent( const OUString& rURL );
/**
* This method registers a newly created content instance with the
* content provider. It should be called directly after creating a new
* content instance. The provider can reuse a registered instance upon
* subsequent requests for content instances with an identifier
* of a registered instance.
* Note that the provider does not hold a hard reference on the
* registered instance. If last external reference is gone, the provider
* will remove the instance from its inventory of known instances.
* Nothing will happen in case an already registered instance shall
* be registered more than once.
*
* @param the content instance that is to be registered.
*/
void registerNewContent(
const css::uno::Reference< css::ucb::XContent > & xContent );
public:
// Construction/Destruction
ContentProviderImplHelper(
const css::uno::Reference< css::uno::XComponentContext >& rxContext );
virtual ~ContentProviderImplHelper() override;
// XServiceInfo
virtual OUString SAL_CALL
getImplementationName() override = 0;
virtual sal_Bool SAL_CALL
supportsService( const OUString& ServiceName ) override;
virtual css::uno::Sequence< OUString > SAL_CALL
getSupportedServiceNames() override = 0;
// XContentProvider
/**
* This method returns a content with the requested id.
*
* The implementation should:
*
* - Check, whether the Identifier is valid ( URL syntax ).
* - Use queryExistingContent(...) to determine, whether there exists
* already a content with the given id.
* - Return the possibly existing content.Create and return a new
* content, otherwise
*/
virtual css::uno::Reference< css::ucb::XContent > SAL_CALL
queryContent( const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier ) override = 0;
virtual sal_Int32 SAL_CALL
compareContentIds( const css::uno::Reference< css::ucb::XContentIdentifier >& Id1,
const css::uno::Reference< css::ucb::XContentIdentifier >& Id2 ) override;
// Non-interface methods.
/**
* This method returns a mutex, which protects the content list of the
* provider. So you can prevent modifications of that list easily.
*
* @return the mutex.
*/
osl::Mutex& getContentListMutex() { return m_aMutex; }
/**
* This method fills a list with all contents existing at calling time.
* Note: You may prevent modifications of the content list at any time
* by acquiring the content list mutex of the provider.
*
* @param rContents is the list to fill with the children.
*/
void queryExistingContents( ContentRefList& rContents );
/**
* This method returns the propertyset containing the Additional Core
* Properties of a content.
*
* @param rKey is the key for the propertyset.
* @param bCreate is a flag indicating whether the propertyset shall
* be created in case it does not exist.
* @return the propertyset containing the Additional Core Properties.
*/
css::uno::Reference< css::ucb::XPersistentPropertySet >
getAdditionalPropertySet( const OUString& rKey, bool bCreate );
/**
* This method renames the propertyset containing the Additional Core
* Properties of a content.
*
* @param rOldKey is the old key of the propertyset.
* @param rNewKey is the new key for the propertyset.
* @param bRecursive is a flag indicating whether propertysets for
* children described by rOldKey shall be renamed, too.
* @return True, if the operation succeeded - False, otherwise.
*/
bool renameAdditionalPropertySet( const OUString& rOldKey,
const OUString& rNewKey,
bool bRecursive );
/**
* This method copies the propertyset containing the Additional Core
* Properties of a content.
*
* @param rSourceKey is the key of the source propertyset.
* @param rTargetKey is the key of the target propertyset.
* @param bRecursive is a flag indicating whether propertysets for
* children described by rSourceKey shall be copied, too.
* @return True, if the operation succeeded - False, otherwise.
*/
bool copyAdditionalPropertySet( const OUString& rSourceKey,
const OUString& rTargetKey,
bool bRecursive );
/**
* This method removes the propertyset containing the Additional Core
* Properties of a content.
*
* @param rKey is the key of the propertyset.
* @param bRecursive is a flag indicating whether propertysets for
* children described by rOldKey shall be removed, too.
* @return True, if the operation succeeded - False, otherwise.
*/
bool removeAdditionalPropertySet( const OUString& rKey,
bool bRecursive );
};
} // namespace ucbhelper
#endif /* ! INCLUDED_UCBHELPER_PROVIDERHELPER_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
