xref: /aoo4110/main/ucb/source/ucp/file/prov.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef _PROV_HXX_
25*b1cdbd2cSJim Jagielski #define _PROV_HXX_
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <cppuhelper/weak.hxx>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #include "osl/mutex.hxx"
30*b1cdbd2cSJim Jagielski #include <ucbhelper/macros.hxx>
31*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/XInterface.hpp>
32*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XTypeProvider.hpp>
33*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XInitialization.hpp>
34*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XSingleServiceFactory.hpp>
35*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp>
36*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XServiceInfo.hpp>
37*b1cdbd2cSJim Jagielski #include <com/sun/star/ucb/XContentProvider.hpp>
38*b1cdbd2cSJim Jagielski #include <com/sun/star/ucb/XContentIdentifierFactory.hpp>
39*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/XPropertySet.hpp>
40*b1cdbd2cSJim Jagielski #include <com/sun/star/ucb/XFileIdentifierConverter.hpp>
41*b1cdbd2cSJim Jagielski #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski // FileProvider
44*b1cdbd2cSJim Jagielski 
45*b1cdbd2cSJim Jagielski 
46*b1cdbd2cSJim Jagielski 
47*b1cdbd2cSJim Jagielski namespace fileaccess {
48*b1cdbd2cSJim Jagielski 
49*b1cdbd2cSJim Jagielski 	// Forward declaration
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski 	class BaseContent;
52*b1cdbd2cSJim Jagielski 	class shell;
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski 	class FileProvider:
55*b1cdbd2cSJim Jagielski 		public cppu::OWeakObject,
56*b1cdbd2cSJim Jagielski 		public com::sun::star::lang::XServiceInfo,
57*b1cdbd2cSJim Jagielski         public com::sun::star::lang::XInitialization,
58*b1cdbd2cSJim Jagielski 		public com::sun::star::lang::XTypeProvider,
59*b1cdbd2cSJim Jagielski 		public com::sun::star::ucb::XContentProvider,
60*b1cdbd2cSJim Jagielski 		public com::sun::star::ucb::XContentIdentifierFactory,
61*b1cdbd2cSJim Jagielski 		public com::sun::star::beans::XPropertySet,
62*b1cdbd2cSJim Jagielski 		public com::sun::star::ucb::XFileIdentifierConverter
63*b1cdbd2cSJim Jagielski 	{
64*b1cdbd2cSJim Jagielski 		friend class BaseContent;
65*b1cdbd2cSJim Jagielski 	public:
66*b1cdbd2cSJim Jagielski 
67*b1cdbd2cSJim Jagielski 		FileProvider( const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& xMSF );
68*b1cdbd2cSJim Jagielski 		~FileProvider();
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski 		// XInterface
71*b1cdbd2cSJim Jagielski 		virtual com::sun::star::uno::Any SAL_CALL
72*b1cdbd2cSJim Jagielski 		queryInterface(
73*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Type& aType )
74*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException);
75*b1cdbd2cSJim Jagielski 
76*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
77*b1cdbd2cSJim Jagielski 		acquire(
78*b1cdbd2cSJim Jagielski 			void )
79*b1cdbd2cSJim Jagielski 			throw();
80*b1cdbd2cSJim Jagielski 
81*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
82*b1cdbd2cSJim Jagielski 		release(
83*b1cdbd2cSJim Jagielski 			void )
84*b1cdbd2cSJim Jagielski 			throw();
85*b1cdbd2cSJim Jagielski 
86*b1cdbd2cSJim Jagielski 		// XServiceInfo
87*b1cdbd2cSJim Jagielski 		virtual rtl::OUString SAL_CALL
88*b1cdbd2cSJim Jagielski 		getImplementationName(
89*b1cdbd2cSJim Jagielski 			void )
90*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
91*b1cdbd2cSJim Jagielski 
92*b1cdbd2cSJim Jagielski 		virtual sal_Bool SAL_CALL
93*b1cdbd2cSJim Jagielski 		supportsService(
94*b1cdbd2cSJim Jagielski 			const rtl::OUString& ServiceName )
95*b1cdbd2cSJim Jagielski 			throw(com::sun::star::uno::RuntimeException );
96*b1cdbd2cSJim Jagielski 
97*b1cdbd2cSJim Jagielski 		virtual com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
98*b1cdbd2cSJim Jagielski 		getSupportedServiceNames(
99*b1cdbd2cSJim Jagielski 			void )
100*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
101*b1cdbd2cSJim Jagielski 
102*b1cdbd2cSJim Jagielski 
103*b1cdbd2cSJim Jagielski 		static com::sun::star::uno::Reference< com::sun::star::lang::XSingleServiceFactory > SAL_CALL
104*b1cdbd2cSJim Jagielski 		createServiceFactory(
105*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& rxServiceMgr );
106*b1cdbd2cSJim Jagielski 
107*b1cdbd2cSJim Jagielski 		static com::sun::star::uno::Reference< com::sun::star::uno::XInterface > SAL_CALL
108*b1cdbd2cSJim Jagielski 		CreateInstance(
109*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& xMultiServiceFactory );
110*b1cdbd2cSJim Jagielski 
111*b1cdbd2cSJim Jagielski 		// XTypeProvider
112*b1cdbd2cSJim Jagielski 
113*b1cdbd2cSJim Jagielski 		XTYPEPROVIDER_DECL()
114*b1cdbd2cSJim Jagielski 
115*b1cdbd2cSJim Jagielski         // XInitialization
116*b1cdbd2cSJim Jagielski         virtual void SAL_CALL
117*b1cdbd2cSJim Jagielski         initialize(
118*b1cdbd2cSJim Jagielski             const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments )
119*b1cdbd2cSJim Jagielski             throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
120*b1cdbd2cSJim Jagielski 
121*b1cdbd2cSJim Jagielski 
122*b1cdbd2cSJim Jagielski 		// XContentProvider
123*b1cdbd2cSJim Jagielski 		virtual com::sun::star::uno::Reference< com::sun::star::ucb::XContent > SAL_CALL
124*b1cdbd2cSJim Jagielski 		queryContent(
125*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::ucb::XContentIdentifier >& Identifier )
126*b1cdbd2cSJim Jagielski 			throw( com::sun::star::ucb::IllegalIdentifierException,
127*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException );
128*b1cdbd2cSJim Jagielski 
129*b1cdbd2cSJim Jagielski 		// XContentIdentifierFactory
130*b1cdbd2cSJim Jagielski 
131*b1cdbd2cSJim Jagielski 		virtual com::sun::star::uno::Reference< com::sun::star::ucb::XContentIdentifier > SAL_CALL
132*b1cdbd2cSJim Jagielski 		createContentIdentifier(
133*b1cdbd2cSJim Jagielski 			const rtl::OUString& ContentId )
134*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
135*b1cdbd2cSJim Jagielski 
136*b1cdbd2cSJim Jagielski 
137*b1cdbd2cSJim Jagielski 		virtual sal_Int32 SAL_CALL
138*b1cdbd2cSJim Jagielski 		compareContentIds(
139*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::ucb::XContentIdentifier >& Id1,
140*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::ucb::XContentIdentifier >& Id2 )
141*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
142*b1cdbd2cSJim Jagielski 
143*b1cdbd2cSJim Jagielski 		// XProperySet
144*b1cdbd2cSJim Jagielski 
145*b1cdbd2cSJim Jagielski 		virtual com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo > SAL_CALL
146*b1cdbd2cSJim Jagielski 		getPropertySetInfo(  )
147*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
148*b1cdbd2cSJim Jagielski 
149*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
150*b1cdbd2cSJim Jagielski 		setPropertyValue(
151*b1cdbd2cSJim Jagielski 			const rtl::OUString& aPropertyName,
152*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Any& aValue )
153*b1cdbd2cSJim Jagielski 			throw( com::sun::star::beans::UnknownPropertyException,
154*b1cdbd2cSJim Jagielski 				   com::sun::star::beans::PropertyVetoException,
155*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::IllegalArgumentException,
156*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::WrappedTargetException,
157*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException );
158*b1cdbd2cSJim Jagielski 
159*b1cdbd2cSJim Jagielski 		virtual com::sun::star::uno::Any SAL_CALL
160*b1cdbd2cSJim Jagielski 		getPropertyValue(
161*b1cdbd2cSJim Jagielski 			const rtl::OUString& PropertyName )
162*b1cdbd2cSJim Jagielski 			throw( com::sun::star::beans::UnknownPropertyException,
163*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::WrappedTargetException,
164*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException );
165*b1cdbd2cSJim Jagielski 
166*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
167*b1cdbd2cSJim Jagielski 		addPropertyChangeListener(
168*b1cdbd2cSJim Jagielski 			const rtl::OUString& aPropertyName,
169*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener >& xListener )
170*b1cdbd2cSJim Jagielski 			throw( com::sun::star::beans::UnknownPropertyException,
171*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::WrappedTargetException,
172*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException);
173*b1cdbd2cSJim Jagielski 
174*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
175*b1cdbd2cSJim Jagielski 		removePropertyChangeListener(
176*b1cdbd2cSJim Jagielski 			const rtl::OUString& aPropertyName,
177*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener >& aListener )
178*b1cdbd2cSJim Jagielski 			throw( com::sun::star::beans::UnknownPropertyException,
179*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::WrappedTargetException,
180*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException );
181*b1cdbd2cSJim Jagielski 
182*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
183*b1cdbd2cSJim Jagielski 		addVetoableChangeListener(
184*b1cdbd2cSJim Jagielski 			const rtl::OUString& PropertyName,
185*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::beans::XVetoableChangeListener >& aListener )
186*b1cdbd2cSJim Jagielski 			throw( com::sun::star::beans::UnknownPropertyException,
187*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::WrappedTargetException,
188*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException );
189*b1cdbd2cSJim Jagielski 
190*b1cdbd2cSJim Jagielski 		virtual void SAL_CALL
191*b1cdbd2cSJim Jagielski 		removeVetoableChangeListener(
192*b1cdbd2cSJim Jagielski 			const rtl::OUString& PropertyName,
193*b1cdbd2cSJim Jagielski 			const com::sun::star::uno::Reference< com::sun::star::beans::XVetoableChangeListener >& aListener )
194*b1cdbd2cSJim Jagielski 			throw( com::sun::star::beans::UnknownPropertyException,
195*b1cdbd2cSJim Jagielski 				   com::sun::star::lang::WrappedTargetException,
196*b1cdbd2cSJim Jagielski 				   com::sun::star::uno::RuntimeException);
197*b1cdbd2cSJim Jagielski 
198*b1cdbd2cSJim Jagielski 
199*b1cdbd2cSJim Jagielski 		// XFileIdentifierConverter
200*b1cdbd2cSJim Jagielski 
201*b1cdbd2cSJim Jagielski 		virtual sal_Int32 SAL_CALL
202*b1cdbd2cSJim Jagielski 		getFileProviderLocality( const rtl::OUString& BaseURL )
203*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
204*b1cdbd2cSJim Jagielski 
205*b1cdbd2cSJim Jagielski 		virtual rtl::OUString SAL_CALL getFileURLFromSystemPath( const rtl::OUString& BaseURL,
206*b1cdbd2cSJim Jagielski 																 const rtl::OUString& SystemPath )
207*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
208*b1cdbd2cSJim Jagielski 
209*b1cdbd2cSJim Jagielski 		virtual rtl::OUString SAL_CALL getSystemPathFromFileURL( const rtl::OUString& URL )
210*b1cdbd2cSJim Jagielski 			throw( com::sun::star::uno::RuntimeException );
211*b1cdbd2cSJim Jagielski 
212*b1cdbd2cSJim Jagielski 
213*b1cdbd2cSJim Jagielski 	private:
214*b1cdbd2cSJim Jagielski         // methods
215*b1cdbd2cSJim Jagielski         void SAL_CALL init();
216*b1cdbd2cSJim Jagielski 
217*b1cdbd2cSJim Jagielski 		// Members
218*b1cdbd2cSJim Jagielski 		com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >  m_xMultiServiceFactory;
219*b1cdbd2cSJim Jagielski 
220*b1cdbd2cSJim Jagielski 		void SAL_CALL initProperties( void );
221*b1cdbd2cSJim Jagielski 		osl::Mutex   m_aMutex;
222*b1cdbd2cSJim Jagielski 		rtl::OUString m_HostName;
223*b1cdbd2cSJim Jagielski 		rtl::OUString m_HomeDirectory;
224*b1cdbd2cSJim Jagielski 		sal_Int32     m_FileSystemNotation;
225*b1cdbd2cSJim Jagielski 
226*b1cdbd2cSJim Jagielski 		com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo >     m_xPropertySetInfo;
227*b1cdbd2cSJim Jagielski 
228*b1cdbd2cSJim Jagielski 		shell*                                                                        m_pMyShell;
229*b1cdbd2cSJim Jagielski 	};
230*b1cdbd2cSJim Jagielski 
231*b1cdbd2cSJim Jagielski }       // end namespace fileaccess
232*b1cdbd2cSJim Jagielski 
233*b1cdbd2cSJim Jagielski #endif
234*b1cdbd2cSJim Jagielski 
235