Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: packages ::

unpublished interface XDataSinkEncrSupport
Usage Restrictions
not published
Description
Allows to get access to the stream of a PackageStream.
Methods' Summary
getDataStream Allows to get access to the data of the PackageStream.  
getRawStream Allows to get access to the data of the PackageStream as to raw stream. In case stream is not encrypted an exception will be thrown.  
setDataStream Allows to set a data stream for the PackageStream.  
setRawStream Allows to set raw stream for the PackageStream. The PackageStream object can not be marked as encrypted one, an exception will be thrown in such case.  
getPlainRawStream Allows to get access to the raw data of the stream as it is stored in the package.  
Methods' Details
getDataStream
::com::sun::star::io::XInputStream
getDataStream()
raises( WrongPasswordException,
::com::sun::star::io::IOException );
Description
Allows to get access to the data of the PackageStream.

In case stream is encrypted one and the key for the stream is not set, an exception must be thrown.

Returns
the stream
Throws
::com::sun::star::packages::WrongPasswordException no key or a wrong one is set
Throws
::com::sun::star::io::IOException in case of io problems during retrieving
getRawStream
::com::sun::star::io::XInputStream
getRawStream()
raises( NoEncryptionException,
::com::sun::star::io::IOException );
Description
Allows to get access to the data of the PackageStream as to raw stream. In case stream is not encrypted an exception will be thrown.

The difference of raw stream is that it contains header for encrypted data, so an encrypted stream can be copyed from one PackageStream to another one without decryption.

Returns
the raw representation of stream
Throws
::com::sun::star::packages::NoEncryptionException the PackageStream object is not encrypted
Throws
::com::sun::star::io::IOException in case of io problems during retrieving
setDataStream
void
setDataStream( [in] ::com::sun::star::io::XInputStream  aStream )
raises( ::com::sun::star::io::IOException );
Description
Allows to set a data stream for the PackageStream.

In case PackageStream is marked as encrypted the data stream will be encrypted on storing.

Parameter aStream
new data stream
Throws
::com::sun::star::io::IOException in case of io problems
setRawStream
void
setRawStream( [in] ::com::sun::star::io::XInputStream  aStream )
raises( EncryptionNotAllowedException,
NoRawFormatException,
::com::sun::star::io::IOException );
Description
Allows to set raw stream for the PackageStream. The PackageStream object can not be marked as encrypted one, an exception will be thrown in such case.
Parameter aStream
the new raw representation of stream
Throws
::com::sun::star::packages::EncryptionNotAllowedException the PackageStream object is marked as encrypted
Throws
::com::sun::star::packages::NoRawFormatException the stream is not a correct raw representation of encrypted package stream
Throws
::com::sun::star::io::IOException in case of io problems during retrieving
getPlainRawStream
::com::sun::star::io::XInputStream
getPlainRawStream()
raises( ::com::sun::star::io::IOException );
Description
Allows to get access to the raw data of the stream as it is stored in the package.
Returns
the plain raw stream as it is stored in the package
Throws
::com::sun::star::io::IOException in case of io problems during retrieving
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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