<html> <head> <title>Service StorageStream</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="StorageStream-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">embed</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">service StorageStream</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>This is a service that represents a stream that can be provided by <a href="XStorage.html">XStorage</a>::openStreamElement() call implemented by <a href="Storage.html">Storage</a> service. </dd> <dd><p> In case a stream is open with readwrite access only one instance of the stream can exist. </p> </dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XStream.html">XStream</a></td> <td class="imsum_right"><p>allows to get access to ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a> and ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a> implementations. (<a href="#XStream">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><p>allows to control object lifetime. (<a href="#XComponent">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><p>allows to get access to stream properties. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XSeekable.html">XSeekable</a></td> <td class="imsum_right"><p>allows to seek to a specified position within the stream. (<a href="#XSeekable">details</a>)</p> </td> </tr> <tr> <td class="imsum_left"><a href="XEncryptionProtectedSource.html">XEncryptionProtectedSource</a></td> <td class="imsum_right"><p>allows to set password to the stream. (<a href="#XEncryptionProtectedSource">details</a>)</p> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">string<br> <a href="#MediaType">MediaType</a></td> <td class="imsum_right">allows to get and set media type of the stream. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsCompressed">IsCompressed</a></td> <td class="imsum_right">specifies if the stream should be compressed next time it is stored. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsEncrypted">IsEncrypted</a></td> <td class="imsum_right">allows to detect if the stream is encrypted. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseCommonStoragePasswordEncryption">UseCommonStoragePasswordEncryption</a></td> <td class="imsum_right">specifies whether the stream will become encrypted next time the common storage password holder is commited. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#Size">Size</a></td> <td class="imsum_right">allows to detect size of the stream in bytes. </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XStream" class="membertitle">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XStream.html">XStream</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to get access to ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a> and ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a> implementations. </dd> <dd><p> In case the storage stream is open readonly the returned reference to ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a> will be empty. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XComponent" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to control object lifetime. </dd> <dd><p> A storage stream is created by a storage and has a restrictions depending on the mode the stream is opened in. </p> <p> In case a stream is opened with read-write access only one instance of the stream can exist. It means that the stream can not be reopened even for readonly access until the readwrite instance is disposed. From the other side it is possible to open multiple streams for readonly access. But because of the rule mentioned above it will not be possible to open the stream for read-write access until all the readonly instances are disposed. </p> <p> The stream must be disposed by ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a>::<a href="../lang/XComponent.html#dispose">dispose()</a> call or by explicit closing of input and output ( if provided ) streams implementations with ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>::<a href="../io/XInputStream.html#closeInput">closeInput()</a> and ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a>::<a href="../io/XOutputStream.html#closeOutput">closeOutput()</a> calls. </p> <p> When a stream is disposed all the changes that were done for it are automatically flashed, so that they becomes visible from parent storage. It is also possible to flash the stream explicitly. </p> <p> In case parent storage is disposed the stream is disposed automatically. </p> <p> In case a stream is disposed any call to it's methods should result in ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to get access to stream properties. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XSeekable" class="membertitle">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XSeekable.html">XSeekable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows to seek to a specified position within the stream. </dd> <dd><p> This interface must be supported in case either seekable readonly or read-write access is requested. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XEncryptionProtectedSource" class="membertitle"><a href="XEncryptionProtectedSource.html">XEncryptionProtectedSource</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows to set password to the stream. </dd> <dd><p> This interface must be supported by a stream with readwrite access to allow to set a password that should be used next time the stream is stored. </p> <p> If the password is set or changed by this interface and the stream is closed the new password should be used to get access to the stream next time. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="MediaType" class="membertitle">MediaType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>MediaType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>allows to get and set media type of the stream. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsCompressed" class="membertitle">IsCompressed</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsCompressed</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the stream should be compressed next time it is stored. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsEncrypted" class="membertitle">IsEncrypted</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsEncrypted</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>allows to detect if the stream is encrypted. </dd> <dd><p> The property value <b>true</b> means that the stream is currently encrypted. <b>false</b> - the stream is not encrypted. </p> <p> If somebody sets a password explicitly by using <a href="XEncryptionProtectedSource.html">XEncryptionProtectedSource</a> interface the value is automatically set to <b>true</b>. If the interface is used to remove the encryption - the value is automatically set to <b>false</b>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseCommonStoragePasswordEncryption" class="membertitle">UseCommonStoragePasswordEncryption</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseCommonStoragePasswordEncryption</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the stream will become encrypted next time the common storage password holder is commited. </dd> <dd><p> The property value <b>true</b> means that the stream will become encrypted after the closest storage in the parent hierarchy, that has common storage password, is commited. <b>false</b> - the stream will not react to commit of such a storage. </p> <p> In case stream is not encrypted and the property is set to <b>true</b>, the stream will stay nonencrypted until the closest storage in the parent hierarchy, that has common storage password, is commited. On the commit the stream will be encrypted with the common storage password. If there is no such storage in the hierarchy the stream will not be encrypted at all. Thus this property must be set very carefully. </p> <p> If somebody sets a password explicitly by using <a href="XEncryptionProtectedSource.html">XEncryptionProtectedSource</a> interface the value is automatically set to <b>false</b> and the stream becomes encrypted with specified password immediatelly. </p> <p> In case stream is encrypted one and the value is set to <b>true</b> the stream becomes nonencrypted until the common storage password holder is commited. The data about previously set password ( if any ) will be removed and the stream can be accessed as nonencrypted stream. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Size" class="membertitle">Size</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>Size</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>allows to detect size of the stream in bytes. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
2964
