INTEGRATION: CWS mav05 (1.1.2); FILE ADDED

2003/09/04 10:32:26 mav 1.1.2.4: #i15929# WrongPasswordException.idl is in packages now
2003/07/09 12:09:02 mav 1.1.2.3: #i15929# fix typo
2003/07/08 13:30:35 mav 1.1.2.2: #i15929# encrypted streams access
2003/07/08 11:34:56 mav 1.1.2.1: #i15929# XDataSinkEncrSupport.idl

1 files changed, 192 insertions, 0 deletions

diff --git a/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl b/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl
new file mode 100644
index 000000000000..c268bdfd0c09
--- /dev/null
+++ b/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl
@@ -0,0 +1,192 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XDataSinkEncrSupport.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2003-09-11 10:29:44 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_io_XDataSinkEncrSupport_idl__
+#define __com_sun_star_io_XDataSinkEncrSupport_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.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_packages_WrongPasswordException_idl__
+#include <com/sun/star/packages/WrongPasswordException.idl>
+#endif
+
+#ifndef __com_sun_star_packages_NoEncryptionException_idl__
+#include <com/sun/star/packages/NoEncryptionException.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
+
+
+//=============================================================================
+
+module com {  module sun {  module star {  module packages {
+
+//=============================================================================
+
+/** Allows to get access to the stream of a <type>PackageStream</type>.
+ */
+interface XDataSinkEncrSupport: com::sun::star::uno::XInterface
+{
+    //-------------------------------------------------------------------------
+    /** Allows to get access to the data of the PackageStream.
+    <p>
+        In case stream is encrypted one and the key for the stream is not set,
+    an exception must be thrown.
+    </p>
+
+    @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
+     */
+    ::com::sun::star::io::XInputStream getDataStream()
+        raises( ::com::sun::star::packages::WrongPasswordException,
+                ::com::sun::star::io::IOException );
+
+
+    //-------------------------------------------------------------------------
+    /** 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.
+    <p>
+        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.
+    </p>
+
+    @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
+     */
+    ::com::sun::star::io::XInputStream getRawStream()
+        raises( ::com::sun::star::packages::NoEncryptionException,
+                ::com::sun::star::io::IOException );
+
+    //-------------------------------------------------------------------------
+    /** Allows to set a data stream for the PackageStream.
+    <p>
+        In case PackageStream is marked as encrypted the data stream will be encrypted on storing.
+    </p>
+
+    @param aStream
+        new data stream
+
+    @throws ::com::sun::star::io::IOException
+        in case of io problems
+     */
+    void setDataStream( [in] ::com::sun::star::io::XInputStream aStream )
+        raises( ::com::sun::star::io::IOException );
+
+    //-------------------------------------------------------------------------
+    /** 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.
+
+    @param 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
+     */
+    void setRawStream( [in] ::com::sun::star::io::XInputStream aStream )
+        raises( ::com::sun::star::packages::EncryptionNotAllowedException,
+                ::com::sun::star::packages::NoRawFormatException,
+                ::com::sun::star::io::IOException );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif