summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/packages/XDataSinkEncrSupport.idl')
-rw-r--r--offapi/com/sun/star/packages/XDataSinkEncrSupport.idl142
1 files changed, 142 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 000000000..05c0cbb65
--- /dev/null
+++ b/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl
@@ -0,0 +1,142 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+ */
+#ifndef __com_sun_star_packages_XDataSinkEncrSupport_idl__
+#define __com_sun_star_packages_XDataSinkEncrSupport_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/io/XInputStream.idl>
+
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/packages/WrongPasswordException.idl>
+#include <com/sun/star/packages/NoEncryptionException.idl>
+
+#include <com/sun/star/packages/EncryptionNotAllowedException.idl>
+#include <com/sun/star/packages/NoRawFormatException.idl>
+
+
+
+module com { module sun { module star { module packages {
+
+
+/** Allows to get access to the stream of a PackageStream.
+ */
+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::packages::zip::ZipException,
+ ::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 copied 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 );
+
+ /** 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::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 getPlainRawStream()
+ raises( ::com::sun::star::io::IOException,
+ ::com::sun::star::packages::NoEncryptionException );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */