offapi/com/sun/star/embed/XStorageRawAccess.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XStorageRawAccess.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_embed_XStorageRawAccess_idl__
  31 #define __com_sun_star_embed_XStorageRawAccess_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XStream_idl__
  38 #include <com/sun/star/io/XStream.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_XInputStream_idl__
  42 #include <com/sun/star/io/XInputStream.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_io_IOException_idl__
  46 #include <com/sun/star/io/IOException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  50 #include <com/sun/star/lang/IllegalArgumentException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_embed_StorageWrappedTargetException_idl__
  54 #include <com/sun/star/embed/StorageWrappedTargetException.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_embed_InvalidStorageException_idl__
  58 #include <com/sun/star/embed/InvalidStorageException.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  62 #include <com/sun/star/container/NoSuchElementException.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_ElementExistException_idl__
  66 #include <com/sun/star/container/ElementExistException.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_packages_NoEncryptionException_idl__
  70 #include <com/sun/star/packages/NoEncryptionException.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_packages_NoRawFormatException_idl__
  74 #include <com/sun/star/packages/NoRawFormatException.idl>
  75 #endif
  76
  77
  78 //============================================================================
  79
  80  module com {  module sun {  module star {  module embed {
  81
  82 //============================================================================
  83 /** This interface represents main storage functionality.
  84  */
  85 interface XStorageRawAccess
  86 {
  87     // -----------------------------------------------------------------------
  88     /** allows to get a plain raw stream representing a package stream.
  89
  90         <p>
  91         This method returns a stream from the package as it is stored there,
  92         without any decompression/decription and etc. This method can be
  93         helpful to check file consistency, for example by signing.
  94         </p>
  95
  96         @returns
  97             the raw representation of encrypted stream with all the data
  98             required to copy the stream without information loss
  99
 100         @param sStreamName
 101             the name of the substream that should be open
 102
 103         @throws ::com::sun::star::embed::InvalidStorageException
 104             this storage is in invalid state for any reason
 105
 106         @throws ::com::sun::star::lang::IllegalArgumentException
 107             one of provided arguments is illegal
 108
 109         @throws ::com::sun::star::container::NoSuchElementException
 110             there is no element with specified name
 111
 112         @throws ::com::sun::star::io::IOException
 113             in case of io errors during stream opening
 114
 115         @throws ::com::sun::star::embed::StorageWrappedTargetException
 116             wraps other exceptions
 117      */
 118     ::com::sun::star::io::XInputStream getPlainRawStreamElement(
 119             [in] string sStreamName )
 120         raises( ::com::sun::star::embed::InvalidStorageException,
 121                 ::com::sun::star::lang::IllegalArgumentException,
 122                 ::com::sun::star::container::NoSuchElementException,
 123                 ::com::sun::star::io::IOException,
 124                 ::com::sun::star::embed::StorageWrappedTargetException );
 125
 126     // -----------------------------------------------------------------------
 127     /** allows to get a raw stream representing encrypted stream with header.
 128
 129         <p>
 130         This method allows to transport encrypted streams without decryption.
 131         Mainly this method is introduced to allow to copy one encrypted
 132         storage stream to another without decryption. It is not reccomended to
 133         use this method outside of storage implementation since different
 134         storages implementation could have different encryption format. If the
 135         method is used outside of storage implementation the user code is
 136         resposible to get sure that the raw format of source and target
 137         storages is the same.
 138         </p>
 139
 140         <p>
 141         The difference of this method from the previous one is that it handles
 142         only encrypted streams. The contents of returned by these methods
 143         streams can differ for the same entry, since this method can add
 144         additional data into the stream to allow successful insertion.
 145         </p>
 146
 147         @param sStreamName
 148             the name of the substream that should be open
 149
 150         @param xInputStream
 151             a raw stream representing encrypted stream
 152
 153         @throws ::com::sun::star::embed::InvalidStorageException
 154             this storage is in invalid state for any reason
 155
 156         @throws ::com::sun::star::lang::IllegalArgumentException
 157             one of provided arguments is illegal
 158
 159         @throws ::com::sun::star::packages::NoEncryptionException
 160             the stream is not an encrypted one
 161
 162         @throws ::com::sun::star::container::NoSuchElementException
 163             there is no element with specified name
 164
 165         @throws ::com::sun::star::io::IOException
 166             in case of io errors during stream opening
 167
 168         @throws ::com::sun::star::embed::StorageWrappedTargetException
 169             wraps other exceptions
 170      */
 171     ::com::sun::star::io::XInputStream getRawEncrStreamElement(
 172             [in] string sStreamName )
 173         raises( ::com::sun::star::embed::InvalidStorageException,
 174                 ::com::sun::star::lang::IllegalArgumentException,
 175                 ::com::sun::star::packages::NoEncryptionException,
 176                 ::com::sun::star::container::NoSuchElementException,
 177                 ::com::sun::star::io::IOException,
 178                 ::com::sun::star::embed::StorageWrappedTargetException );
 179
 180     // -----------------------------------------------------------------------
 181     /** allows to insert a raw stream representing encrypted stream with
 182         header.
 183
 184         <p>
 185         This method allows to insert a stream retrived by
 186         <method>XStorageRawAccess::getRawEncrStreamElement()</method> into a
 187         storage.
 188         </p>
 189
 190         <p>
 191         This method allows to transport encrypted streams without decryption.
 192         Mainly this method is introduced to allow to copy one encrypted
 193         storage stream to another without decryption. It is not reccomended to
 194         use this method outside of storage implementation since different
 195         storages implementation could have different encryption format.
 196         </p>
 197
 198         @param sStreamName
 199             the name of the substream that should be open
 200
 201         @param xInputStream
 202             a raw stream representing encrypted stream
 203
 204         @throws ::com::sun::star::embed::InvalidStorageException
 205             this storage is in invalid state for any reason
 206
 207         @throws ::com::sun::star::lang::IllegalArgumentException
 208             one of provided arguments is illegal
 209
 210         @throws ::com::sun::star::packages::NoRawFormatException
 211             the stream is not one of raw package stream format
 212
 213         @throws ::com::sun::star::container::ElementExistException
 214             an element with specified name already exists
 215
 216         @throws ::com::sun::star::io::IOException
 217             in case of io errors during stream opening
 218
 219         @throws ::com::sun::star::embed::StorageWrappedTargetException
 220             wraps other exceptions
 221      */
 222     void insertRawEncrStreamElement(
 223             [in] string sStreamName,
 224             [in] ::com::sun::star::io::XInputStream xInStream )
 225         raises( ::com::sun::star::embed::InvalidStorageException,
 226                 ::com::sun::star::lang::IllegalArgumentException,
 227                 ::com::sun::star::packages::NoRawFormatException,
 228                 ::com::sun::star::container::ElementExistException,
 229                 ::com::sun::star::io::IOException,
 230                 ::com::sun::star::embed::StorageWrappedTargetException );
 231 };
 232
 233 //============================================================================
 234
 235 }; }; }; };
 236
 237 #endif
 238