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
278
279
|
/*************************************************************************
*
* $RCSfile: localsinglebackend.hxx,v $
*
* $Revision: 1.5 $
*
* last change: $Author: jb $ $Date: 2002-11-28 09:05:17 $
*
* 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_LOCALBE_LOCALSINGLEBACKEND_HXX_
#define CONFIGMGR_LOCALBE_LOCALSINGLEBACKEND_HXX_
#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XSINGLEBACKEND_HPP_
#include <drafts/com/sun/star/configuration/backend/XSingleBackend.hpp>
#endif // _COM_SUN_STAR_CONFIGURATION_BACKEND_XSINGLEBACKEND_HPP_
#ifndef _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_
#include <com/sun/star/lang/XInitialization.hpp>
#endif // _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
#include <com/sun/star/lang/XServiceInfo.hpp>
#endif // _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#endif // _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
#ifndef _CPPUHELPER_COMPBASE3_HXX_
#include <cppuhelper/compbase3.hxx>
#endif // _CPPUHELPER_COMPBASE3_HXX_
namespace configmgr { namespace localbe {
namespace css = com::sun::star ;
namespace uno = css::uno ;
namespace lang = css::lang ;
//namespace backend = css::configuration::backend ;
namespace backend = drafts::com::sun::star::configuration::backend ;
typedef cppu::WeakComponentImplHelper3<backend::XSingleBackend,
lang::XInitialization,
lang::XServiceInfo> SingleBackendBase ;
class LocalFileLayer ;
/**
Implements the SingleBackend service for local file access.
Layer identifiers in that backend are file URLs.
*/
class LocalSingleBackend : public SingleBackendBase {
public :
/**
Service constructor from a service factory.
@param xFactory service factory
*/
LocalSingleBackend(
const uno::Reference<lang::XMultiServiceFactory>& xFactory) ;
/** Destructor */
~LocalSingleBackend(void) ;
// XInitialize
virtual void SAL_CALL initialize(
const uno::Sequence<uno::Any>& aParameters)
throw (uno::RuntimeException, uno::Exception) ;
// XSingleBackend
virtual uno::Sequence<rtl::OUString> SAL_CALL listLayerIds(
const rtl::OUString& aComponent,
const rtl::OUString& aEntity)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual rtl::OUString SAL_CALL getUpdateLayerId(
const rtl::OUString& aComponent,
const rtl::OUString& aEntity)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual rtl::OUString SAL_CALL getOwnId(void)
throw (uno::RuntimeException) ;
virtual uno::Reference<backend::XLayer> SAL_CALL getLayer(
const rtl::OUString& aLayerId,
const rtl::OUString& aTimestamp)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual uno::Sequence<uno::Reference<backend::XLayer> > SAL_CALL
getLayers(const uno::Sequence<rtl::OUString>& aLayerIds,
const rtl::OUString& aTimestamp)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual uno::Sequence<uno::Reference<backend::XLayer> > SAL_CALL
getMultipleLayers(const uno::Sequence<rtl::OUString>& aLayerIds,
const uno::Sequence<rtl::OUString>& aTimestamps)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual uno::Reference<backend::XUpdatableLayer> SAL_CALL
getUpdatableLayer(const rtl::OUString& aLayerId)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual uno::Reference<backend::XLayerHandler> SAL_CALL
getWriteHandler(const rtl::OUString& aLayerId)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
virtual uno::Reference<backend::XSchema> SAL_CALL getSchema(
const rtl::OUString& aComponent)
throw (backend::BackendAccessException,
lang::IllegalArgumentException,
uno::RuntimeException) ;
// XServiceInfo
virtual rtl::OUString SAL_CALL getImplementationName(void)
throw (uno::RuntimeException) ;
virtual sal_Bool SAL_CALL supportsService(
const rtl::OUString& aServiceName)
throw (uno::RuntimeException) ;
virtual uno::Sequence<rtl::OUString> SAL_CALL
getSupportedServiceNames(void)
throw (uno::RuntimeException) ;
/**
Provides the implementation name.
@return implementation name
*/
static rtl::OUString SAL_CALL getName(void) ;
/**
Provides the supported services names
@return service names
*/
static uno::Sequence<rtl::OUString> SAL_CALL getServices(void) ;
public: // helpers for other implementation that need to use the same data
/**
Locates the main layer data and localized data directories in a layer directory hierarchy
*/
static void LocalSingleBackend::getLayerSubDirectories(rtl::OUString const & aLayerBaseUrl,
rtl::OUString& aMainLayerUrl,
rtl::OUString& aSubLayerUrl);
/**
Creates a simple readonly non-composite layer for a component in a base directory
*/
static uno::Reference<backend::XLayer>
createSimpleLayer(const uno::Reference<lang::XMultiServiceFactory>& xFactory,
rtl::OUString const & aLayerBaseUrl,
rtl::OUString const & aComponent);
/**
Creates a simple readonly non-composite layer for a component in a given file
*/
static uno::Reference<backend::XLayer>
createSimpleLayer(const uno::Reference<lang::XMultiServiceFactory>& xFactory,
rtl::OUString const & aComponentUrl);
private :
/** Service factory */
const uno::Reference<lang::XMultiServiceFactory>& mFactory ;
/** Mutex for resources protection */
osl::Mutex mMutex ;
/** Identifier of the user of the backend */
rtl::OUString mOwnId ;
/** Base of the schema data */
rtl::OUString mSchemaDataUrl ;
/**
Base of the default data. Is a list to allow
for multiple layers of default data.
*/
uno::Sequence<rtl::OUString> mDefaultDataUrl ;
/** Base of the user data */
rtl::OUString mUserDataUrl ;
/**
Builds a LocalFileLayer object given a layer id.
Since the LocalFileLayer implements the various
interfaces a layer can be accessed as, a few methods
need one. This method handles the layer id mapping
and the existence or not of sublayers.
@param aLayerId layer id
@return local file layer
@throws com::sun::star::lang::IllegalArgumentException
if the layer id is invalid.
*/
LocalFileLayer *getFileLayer(const rtl::OUString& aLayerId)
throw (lang::IllegalArgumentException) ;
/**
Same as above, but using a component URL and layer index
combination instead of a layer id (which encodes both).
@param aComponent component URL
@param aLayerIndex layer index
@return local file layer
*/
LocalFileLayer *getFileLayer(const rtl::OUString& aComponent,
sal_Int32 aLayerIndex) ;
/**
Maps a layer index (-1 for user layer, 0-x for defaults)
to the appropriate layer and sublayers base directories.
@param aLayerIndex layer index
@param aLayerUrl layer base URL, filled on return
@param aSubLayerUrl sublayer base URL, filled on return
*/
void getLayerDirectories(sal_Int32 aLayerIndex,
rtl::OUString& aLayerUrl,
rtl::OUString& aSubLayerUrl) ;
/**
Tells if a file is more recent than a given date.
The date is formatted YYYYMMDDhhmmssZ.
@param aComponent URL of the component to check
@param aLayerIndex index of the layer involved (-1 = user)
@param aTimestamp timestamp to check against
@return sal_True if the file is more recent, sal_False otherwise
*/
sal_Bool isMoreRecent(const rtl::OUString& aComponent,
sal_Int32 aLayerId,
const rtl::OUString& aTimestamp) ;
} ;
} } // configmgr.localbe
#endif // CONFIGMGR_LOCALBE_LOCALSINGLEBACKEND_HXX_
|
