| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_embed_XOptimizedStorage_idl__ |
| #define __com_sun_star_embed_XOptimizedStorage_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_EncryptionNotAllowedException_idl__ |
| #include <com/sun/star/packages/EncryptionNotAllowedException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_packages_NoRawFormatException_idl__ |
| #include <com/sun/star/packages/NoRawFormatException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_packages_WrongPasswordException_idl__ |
| #include <com/sun/star/packages/WrongPasswordException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_PropertyValue_idl__ |
| #include <com/sun/star/beans/PropertyValue.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_UnknownPropertyException_idl__ |
| #include <com/sun/star/beans/UnknownPropertyException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_PropertyVetoException_idl__ |
| #include <com/sun/star/beans/PropertyVetoException.idl> |
| #endif |
| |
| //============================================================================ |
| |
| module com { module sun { module star { module embed { |
| |
| //============================================================================ |
| /** This is a temporary interface that is introduced to temporarily optimize |
| the document storing process. PLEASE DO NOT USE IT, it might change in any |
| time and will be depricated soon! |
| Another solution will be introduced as final one. |
| */ |
| published interface XOptimizedStorage |
| { |
| // ----------------------------------------------------------------------- |
| /** allows to insert a raw stream representing nonencrypted stream with |
| header. |
| */ |
| void insertRawNonEncrStreamElementDirect( |
| [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 ); |
| |
| // ----------------------------------------------------------------------- |
| /** allows to insert a stream to the storage directly. The stream must |
| stay alive till the storage is commited. |
| */ |
| void insertStreamElementDirect( |
| [in] string sStreamName, |
| [in] ::com::sun::star::io::XInputStream xInStream, |
| [in] sequence < ::com::sun::star::beans::PropertyValue > aProperties ) |
| raises( ::com::sun::star::embed::InvalidStorageException, |
| ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::container::ElementExistException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::embed::StorageWrappedTargetException ); |
| |
| // ----------------------------------------------------------------------- |
| /** allows to copy storage element directly, not guarantied to work. |
| */ |
| void copyElementDirectlyTo( |
| [in] string sSourceName, |
| [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage, |
| [in] string sTargetName ) |
| raises( ::com::sun::star::embed::InvalidStorageException, |
| ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::container::NoSuchElementException, |
| ::com::sun::star::container::ElementExistException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::embed::StorageWrappedTargetException ); |
| |
| // ----------------------------------------------------------------------- |
| /** allows to switch storage persistence to the provided stream. The stream |
| will be filled by the storage. If an empty reference is provided, the |
| storage will create a temporary stream to switch to itself. |
| It is applicable only for root storages. |
| */ |
| void writeAndAttachToStream( |
| [in] ::com::sun::star::io::XStream xStream ) |
| raises( ::com::sun::star::embed::InvalidStorageException, |
| ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::embed::StorageWrappedTargetException ); |
| |
| // ----------------------------------------------------------------------- |
| /** allows to switch storage persistence to the provided URL. The caller is |
| responsible to be sure that the file referenced by the URL contains the |
| same contents as the stream the storage is based currently. Thus using |
| of this method is very dangerous and should be avoided when possible. |
| It is applicable only for root storages. |
| */ |
| void attachToURL( [in] string sURL, |
| [in] boolean bReadOnly ) |
| raises( ::com::sun::star::embed::InvalidStorageException, |
| ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::embed::StorageWrappedTargetException ); |
| |
| // ----------------------------------------------------------------------- |
| /** allows to get property of the child element with the specified name. |
| The implementation of the method might allow to access only subset |
| of the supported by element properties. |
| */ |
| any getElementPropertyValue( [in] string sElementName, |
| [in] string sPropertyName ) |
| raises( ::com::sun::star::embed::InvalidStorageException, |
| ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::container::NoSuchElementException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::beans::UnknownPropertyException, |
| ::com::sun::star::beans::PropertyVetoException, |
| ::com::sun::star::embed::StorageWrappedTargetException ); |
| |
| // ----------------------------------------------------------------------- |
| /** fills the provided stream with the last flushed version of data from |
| the child stream of the storage. |
| |
| @param sStreamName |
| the name of the substream that should be copied |
| |
| @param xTargetStream |
| the target stream where the data must be copied to |
| |
| @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::WrongPasswordException |
| the provided password is wrong |
| |
| @throws ::com::sun::star::io::IOException |
| in case of io errors during stream opening |
| |
| @throws ::com::sun::star::embed::StorageWrappedTargetException |
| wraps other exceptions |
| */ |
| void copyStreamElementData( [in] string sStreamName, |
| [in] ::com::sun::star::io::XStream xTargetStream ) |
| raises( ::com::sun::star::embed::InvalidStorageException, |
| ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::packages::WrongPasswordException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::embed::StorageWrappedTargetException ); |
| |
| }; |
| |
| //============================================================================ |
| |
| }; }; }; }; |
| |
| #endif |
| |