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
|
/*************************************************************************
*
* 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 _UCBHELPER_CONTENTBROKER_HXX
#define _UCBHELPER_CONTENTBROKER_HXX
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.h>
namespace com { namespace sun { namespace star { namespace lang {
class XMultiServiceFactory;
} } } }
namespace com { namespace sun { namespace star { namespace ucb {
class XContentIdentifierFactory;
class XContentProvider;
class XContentProviderManager;
class XCommandProcessor;
} } } }
#include <ucbhelper/configureucb.hxx>
#include "ucbhelper/ucbhelperdllapi.h"
namespace ucbhelper
{
class ContentBroker_Impl;
//=========================================================================
/**
* This class simplifies access to the Universal Content Broker (UCB).
* Currently there can only be one UCB instance per process. This class can
* be used to initialize and deinitialize the Broker and to access its
* interfaces directly.
*/
class UCBHELPER_DLLPUBLIC ContentBroker
{
ContentBroker_Impl* m_pImpl;
// The "one and only" Broker.
static ContentBroker* m_pTheBroker;
private:
UCBHELPER_DLLPRIVATE ContentBroker( const ContentBroker& ); // n.i.
UCBHELPER_DLLPRIVATE ContentBroker& operator=( const ContentBroker& ); // n.i.
/** Constructor.
*
* @param rxSMgr is a Service Manager.
* @param rArguments are the arguments to pass to the
* com.sun.star.ucb.UniversalContentBroker service when creating it.
* Currently, this must be a sequence containing exactly two
* strings, a primary and a secondary configuration key.
* Refer to http://ucb.openoffice.org/docs/ucb-configuration.html
* for more information on UCB configuration.
*/
UCBHELPER_DLLPRIVATE ContentBroker( const ::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiServiceFactory >& rSMgr,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rArguments );
/** Constructor.
*
* @param rxSMgr is a Service Manager.
* @param rData are the data for the for the content providers for
* the new UCB.
*/
UCBHELPER_DLLPRIVATE ContentBroker( const ::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiServiceFactory >& rSMgr,
const ContentProviderDataList & rData );
protected:
/**
* Destructor.
*/
~ContentBroker();
public:
/** Initialize "the one and only" Broker. This method must be called
* exactly once, before the Broker is used in any way.
*
* @param rSMgr is a factory to create services needed in the Broker's
* implementation.
*
* @param rArguments are the arguments to pass to the
* com.sun.star.ucb.UniversalContentBroker service when creating
* it. Currently, this must be a sequence containing exactly two
* strings, a primary and a secondary configuration key.
* Refer to http://ucb.openoffice.org/docs/ucb-configuration.html
* for more information on UCB configuration.
*
* @return True if creation and possible configuration of the Broker
* was successful.
*/
static sal_Bool
initialize( const::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiServiceFactory >& rSMgr,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rArguments );
/** Initialize "the one and only" Broker. This method must be called
* exactly once, before the Broker is used in any way.
*
* @param rSMgr is a factory to create services needed in the Broker's
* implementation.
*
* @param rData are the data for the for the content providers for
* the UCB to initialize.
*
* @return True if creation and possible configuration of the Broker
* was successful.
*/
static sal_Bool
initialize( const::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiServiceFactory >& rSMgr,
const ContentProviderDataList & rData );
/** Deinitialize "the one and only" Broker. Once this method has been
* called, the Broker must not be used any longer.
*/
static void
deinitialize();
/**
* This method returns the Broker, if it was already initialized.
*
* @return the Broker or 0, if ContentBroker::initialize() was not yet
* called or did fail.
*/
static ContentBroker*
get();
/**
* This method returns the Service Manager used to instanciate the Broker.
*
* @return a Service Manager.
*/
::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiServiceFactory >
getServiceManager() const;
/**
* This method returns the XContentIdentifierFactory interface of the
* Broker.
*
* @return a XContentIdentifierFactory interface.
*/
::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContentIdentifierFactory >
getContentIdentifierFactoryInterface() const;
/**
* This method returns the XContentProvider interface of the Broker.
*
* @return a XContentProvider interface.
*/
::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContentProvider >
getContentProviderInterface() const;
/**
* This method returns the XContentProviderManager interface of the Broker.
*
* @return a XContentProviderManager interface.
*/
::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContentProviderManager >
getContentProviderManagerInterface() const;
/**
* This method returns the XCommandProcessor interface of the Broker.
*
* @return a XCommandProcessor interface.
*/
::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandProcessor >
getCommandProcessorInterface() const;
};
} /* namespace ucbhelper */
#endif /* !_UCBHELPER_CONTENTBROKER_HXX */
|
