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
280
281
282
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __FRAMEWORK_CLASSES_SERVICEMANAGER_HXX_
#define __FRAMEWORK_CLASSES_SERVICEMANAGER_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <macros/debug.hxx>
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/uno/Reference.hxx>
#include <rtl/ustring.hxx>
#include <osl/mutex.hxx>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
#define REFERENCE ::com::sun::star::uno::Reference
#define XMULTISERVICEFACTORY ::com::sun::star::lang::XMultiServiceFactory
#define MUTEX ::osl::Mutex
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short create a new global servicemanager
@descr A global servicemanager is neccessary to instanciate UNO-services. To do this, you need
a factory to create new objects with special type. That's the reason for a servicemanager.
@implements -
@base -
@devstatus ready to use
*//*-*************************************************************************************************************/
class ServiceManager
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short standard constructor
@descr This method don't initialize the new global servicemanager!
But we increase an internal ref count. These is needed in dtor to release
all created static references to created service mamanger!
@seealso dtor
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
ServiceManager();
/*-****************************************************************************************************//**
@short standard destructor to delete instance
@descr Here is a good place to destroy the global manager instances!
@seealso ctor
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual ~ServiceManager();
/*-****************************************************************************************************//**
@short initialize global uno service manager and return it
@descr This method create a new manager only at first call. We confiscate this with a static
pointer, which will be initialized only, if it NULL!
Then you can call this method everytime to get a reference to the manager.
If you will initialize an uno application you must set returned reference in ::comphelper::setProcessServiceFactory()!
The created manager use "applicat.rdb" and "userXX.rdb" automaticly.
@seealso -
@param -
@return A reference to the global servicemanager. It can be NULL!
@onerror We return a null-reference.
*//*-*****************************************************************************************************/
REFERENCE< XMULTISERVICEFACTORY > getGlobalUNOServiceManager();
/*-****************************************************************************************************//**
@short initialize global uno service manager and return it
@descr Do the same like getGlobalUNOServiceManager() before, but use "applicat.rdb" only!
@seealso -
@param -
@return A reference to the global servicemanager. It can be NULL!
@onerror We return a null-reference.
*//*-*****************************************************************************************************/
REFERENCE< XMULTISERVICEFACTORY > getSimpleGlobalUNOServiceManager();
/*-****************************************************************************************************//**
@short return a reference to a uno servicemanager instance which use your specified user registry file
@descr This do the same like method before - but instead of "userXX.rdb" we use your file.
These is neccessary, if you will run more then one uno application at the same time in same environment!
All created servicemanager use the same "applicat.rdb" but different user registries.
@ATTENTION Given file name must be a full qualified system file name. If file not already exist we create a new one!
"applicat.rdb", "userXX.rdb" are not valid values!
@seealso method generateGlobalUNOServiceManager()
@seealso method generatePrivateUNOServiceManager()
@param "sUserRegistryFile", full qualified system file name of user registry
@return A reference to the created servicemanager. It can be NULL!
@onerror We return a null-reference.
*//*-*****************************************************************************************************/
REFERENCE< XMULTISERVICEFACTORY > getSharedUNOServiceManager( const ::rtl::OUString& sUserRegistryFile );
/*-****************************************************************************************************//**
@short return a reference to a uno servicemanager instance which use your specified user registry file only
@descr This do the same like methods before - but use your file as the only one registry.
"applicat.rdb" is used here!
@ATTENTION Given file name must be a full qualified system file name. If file not already exist we create a new one!
"applicat.rdb", "userXX.rdb" are not valid values!
If file was new created - you must register services at runtime himself.
Otherwise no service could be created by these manager ...
@seealso method generateGlobalUNOServiceManager()
@seealso method generateSharedUNOServiceManager()
@param "sUserRegistryFile", full qualified system file name of user registry
@return A reference to the created servicemanager. It can be NULL!
@onerror We return a null-reference.
*//*-*****************************************************************************************************/
REFERENCE< XMULTISERVICEFACTORY > getPrivateUNOServiceManager( const ::rtl::OUString& sUserRegistryFile );
//-------------------------------------------------------------------------------------------------------------
// protected methods
//-------------------------------------------------------------------------------------------------------------
protected:
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
/*-****************************************************************************************************//**
@short create our own global mutex to prevent us against multithreaded problems
@descr We use some static member. For correct access to it we must use the global osl mutex ...
but its not fine to do so! These block ALL other operations, which need these mutex too.
That's the reason to create our own static mutex. Only first creation is protected
by the global mutex, using isn't it!
@seealso using
@param -
@return reference to created static own global mutex
@onerror No error should occure.
*//*-*****************************************************************************************************/
MUTEX& impl_getOwnGlobalMutex();
/*-****************************************************************************************************//**
@short create a new global servicemanager instance
@descr Is a helper-method for getManager().
@seealso method getManager()
@param "sRegistryFile", file name of user registry.
@return A reference to a new initialized servicemanager with a valid registry.
It can be NULL, if an error occurred.
@onerror Return a NULL-reference.
*//*-*****************************************************************************************************/
REFERENCE< XMULTISERVICEFACTORY > impl_createManager( const ::rtl::OUString& sRegistryFile );
//-------------------------------------------------------------------------------------------------------------
// debug methods
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short debug-method to check incoming parameter of some other mehods of this class
@descr The following methods are used to check parameters for other methods
of this class. The return value is used directly for an ASSERT(...).
@seealso ASSERTs in implementation!
@param references to checking variables
@return sal_False on invalid parameter<BR>
sal_True otherway
@onerror -
*//*-*****************************************************************************************************/
#ifdef ENABLE_ASSERTIONS
private:
#endif // #ifdef ENABLE_ASSERTIONS
//-------------------------------------------------------------------------------------------------------------
// private variables
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
private:
static REFERENCE< XMULTISERVICEFACTORY >* m_pGlobalServiceManager ;
static REFERENCE< XMULTISERVICEFACTORY >* m_pSimpleGlobalServiceManager ;
static REFERENCE< XMULTISERVICEFACTORY >* m_pSharedServiceManager ;
static REFERENCE< XMULTISERVICEFACTORY >* m_pPrivateServiceManager ;
static sal_Int32 m_nRefCount ;
}; // class ServiceManager
} // namespace framework
#endif // #ifndef __FRAMEWORK_CLASSES_SERVICEMANAGER_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
