Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: embed ::

interface XStorageRawAccess
Description
This interface represents main storage functionality.

Methods' Summary
getPlainRawStreamElement allows to get a plain raw stream representing a package stream.  
getRawEncrStreamElement allows to get a raw stream representing encrypted stream with header.  
insertRawEncrStreamElement allows to insert a raw stream representing encrypted stream with header.  
Methods' Details
getPlainRawStreamElement
::com::sun::star::io::XInputStream
getPlainRawStreamElement( [in] string  sStreamName )
raises( InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
StorageWrappedTargetException );

Description
allows to get a plain raw stream representing a package stream.

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.

Returns
the raw representation of encrypted stream with all the data required to copy the stream without information loss
Parameter 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
getRawEncrStreamElement
::com::sun::star::io::XInputStream
getRawEncrStreamElement( [in] string  sStreamName )
raises( InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::packages::NoEncryptionException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
StorageWrappedTargetException );

Description
allows to get a raw stream representing encrypted stream with header.

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.

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.

Parameter sStreamName
the name of the substream that should be open
Parameter 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
insertRawEncrStreamElement
void
insertRawEncrStreamElement( [in] string  sStreamName,
[in] ::com::sun::star::io::XInputStream  xInStream )
raises( InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::packages::NoRawFormatException,
::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException,
StorageWrappedTargetException );

Description
allows to insert a raw stream representing encrypted stream with header.

This method allows to insert a stream retrived by XStorageRawAccess::getRawEncrStreamElement() into a storage.

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.

Parameter sStreamName
the name of the substream that should be open
Parameter 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
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.