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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XStorageRawAccess.idl,v $
* $Revision: 1.4 $
*
* 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 __com_sun_star_embed_XStorageRawAccess_idl__
#define __com_sun_star_embed_XStorageRawAccess_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_io_XStream_idl__
#include <com/sun/star/io/XStream.idl>
#endif
#ifndef __com_sun_star_io_XInputStream_idl__
#include <com/sun/star/io/XInputStream.idl>
#endif
#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_embed_StorageWrappedTargetException_idl__
#include <com/sun/star/embed/StorageWrappedTargetException.idl>
#endif
#ifndef __com_sun_star_embed_InvalidStorageException_idl__
#include <com/sun/star/embed/InvalidStorageException.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif
#ifndef __com_sun_star_container_ElementExistException_idl__
#include <com/sun/star/container/ElementExistException.idl>
#endif
#ifndef __com_sun_star_packages_NoEncryptionException_idl__
#include <com/sun/star/packages/NoEncryptionException.idl>
#endif
#ifndef __com_sun_star_packages_NoRawFormatException_idl__
#include <com/sun/star/packages/NoRawFormatException.idl>
#endif
//============================================================================
module com { module sun { module star { module embed {
//============================================================================
/** This interface represents main storage functionality.
*/
interface XStorageRawAccess
{
// -----------------------------------------------------------------------
/** allows to get a plain raw stream representing a package stream.
<p>
This method returns a stream from the package as it is stored there,
without any decompression/decription and etc. This method can be
helpful to check file consistency, for example by signing.
</p>
@returns
the raw representation of encrypted stream with all the data
required to copy the stream without information loss
@param sStreamName
the name of the substream that should be open
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
one of provided arguments is illegal
@throws ::com::sun::star::container::NoSuchElementException
there is no element with specified name
@throws ::com::sun::star::io::IOException
in case of io errors during stream opening
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
::com::sun::star::io::XInputStream getPlainRawStreamElement(
[in] string sStreamName )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
// -----------------------------------------------------------------------
/** allows to get a raw stream representing encrypted stream with header.
<p>
This method allows to transport encrypted streams without decryption.
Mainly this method is introduced to allow to copy one encrypted
storage stream to another without decryption. It is not reccomended to
use this method outside of storage implementation since different
storages implementation could have different encryption format. If the
method is used outside of storage implementation the user code is
resposible to get sure that the raw format of source and target
storages is the same.
</p>
<p>
The difference of this method from the previous one is that it handles
only encrypted streams. The contents of returned by these methods
streams can differ for the same entry, since this method can add
additional data into the stream to allow successful insertion.
</p>
@param sStreamName
the name of the substream that should be open
@param xInputStream
a raw stream representing encrypted stream
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
one of provided arguments is illegal
@throws ::com::sun::star::packages::NoEncryptionException
the stream is not an encrypted one
@throws ::com::sun::star::container::NoSuchElementException
there is no element with specified name
@throws ::com::sun::star::io::IOException
in case of io errors during stream opening
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
::com::sun::star::io::XInputStream getRawEncrStreamElement(
[in] string sStreamName )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::packages::NoEncryptionException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
// -----------------------------------------------------------------------
/** allows to insert a raw stream representing encrypted stream with
header.
<p>
This method allows to insert a stream retrived by
<method>XStorageRawAccess::getRawEncrStreamElement()</method> into a
storage.
</p>
<p>
This method allows to transport encrypted streams without decryption.
Mainly this method is introduced to allow to copy one encrypted
storage stream to another without decryption. It is not reccomended to
use this method outside of storage implementation since different
storages implementation could have different encryption format.
</p>
@param sStreamName
the name of the substream that should be open
@param xInputStream
a raw stream representing encrypted stream
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
one of provided arguments is illegal
@throws ::com::sun::star::packages::NoRawFormatException
the stream is not one of raw package stream format
@throws ::com::sun::star::container::ElementExistException
an element with specified name already exists
@throws ::com::sun::star::io::IOException
in case of io errors during stream opening
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void insertRawEncrStreamElement(
[in] string sStreamName,
[in] ::com::sun::star::io::XInputStream xInStream )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::packages::NoRawFormatException,
::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
};
//============================================================================
}; }; }; };
#endif
|
