1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_packages_XDataSinkEncrSupport_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_packages_XDataSinkEncrSupport_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XInputStream_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XInputStream.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_IOException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/io/IOException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_packages_WrongPasswordException_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/packages/WrongPasswordException.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_packages_NoEncryptionException_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/packages/NoEncryptionException.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_packages_EncryptionNotAllowedException_idl__ 47*b1cdbd2cSJim Jagielski#include <com/sun/star/packages/EncryptionNotAllowedException.idl> 48*b1cdbd2cSJim Jagielski#endif 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_packages_NoRawFormatException_idl__ 51*b1cdbd2cSJim Jagielski#include <com/sun/star/packages/NoRawFormatException.idl> 52*b1cdbd2cSJim Jagielski#endif 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski//============================================================================= 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module packages { 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski//============================================================================= 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski/** Allows to get access to the stream of a <type>PackageStream</type>. 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielskiinterface XDataSinkEncrSupport: com::sun::star::uno::XInterface 64*b1cdbd2cSJim Jagielski{ 65*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 66*b1cdbd2cSJim Jagielski /** Allows to get access to the data of the PackageStream. 67*b1cdbd2cSJim Jagielski <p> 68*b1cdbd2cSJim Jagielski In case stream is encrypted one and the key for the stream is not set, 69*b1cdbd2cSJim Jagielski an exception must be thrown. 70*b1cdbd2cSJim Jagielski </p> 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @returns 73*b1cdbd2cSJim Jagielski the stream 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::WrongPasswordException 76*b1cdbd2cSJim Jagielski no key or a wrong one is set 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 79*b1cdbd2cSJim Jagielski in case of io problems during retrieving 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski ::com::sun::star::io::XInputStream getDataStream() 82*b1cdbd2cSJim Jagielski raises( ::com::sun::star::packages::WrongPasswordException, 83*b1cdbd2cSJim Jagielski ::com::sun::star::io::IOException ); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 87*b1cdbd2cSJim Jagielski /** Allows to get access to the data of the PackageStream as to raw stream. 88*b1cdbd2cSJim Jagielski In case stream is not encrypted an exception will be thrown. 89*b1cdbd2cSJim Jagielski <p> 90*b1cdbd2cSJim Jagielski The difference of raw stream is that it contains header for encrypted data, 91*b1cdbd2cSJim Jagielski so an encrypted stream can be copyed from one PackageStream to 92*b1cdbd2cSJim Jagielski another one without decryption. 93*b1cdbd2cSJim Jagielski </p> 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski @returns 96*b1cdbd2cSJim Jagielski the raw representation of stream 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::NoEncryptionException 99*b1cdbd2cSJim Jagielski the PackageStream object is not encrypted 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 102*b1cdbd2cSJim Jagielski in case of io problems during retrieving 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski ::com::sun::star::io::XInputStream getRawStream() 105*b1cdbd2cSJim Jagielski raises( ::com::sun::star::packages::NoEncryptionException, 106*b1cdbd2cSJim Jagielski ::com::sun::star::io::IOException ); 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 109*b1cdbd2cSJim Jagielski /** Allows to set a data stream for the PackageStream. 110*b1cdbd2cSJim Jagielski <p> 111*b1cdbd2cSJim Jagielski In case PackageStream is marked as encrypted the data stream will be encrypted on storing. 112*b1cdbd2cSJim Jagielski </p> 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski @param aStream 115*b1cdbd2cSJim Jagielski new data stream 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 118*b1cdbd2cSJim Jagielski in case of io problems 119*b1cdbd2cSJim Jagielski */ 120*b1cdbd2cSJim Jagielski void setDataStream( [in] ::com::sun::star::io::XInputStream aStream ) 121*b1cdbd2cSJim Jagielski raises( ::com::sun::star::io::IOException ); 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 124*b1cdbd2cSJim Jagielski /** Allows to set raw stream for the PackageStream. 125*b1cdbd2cSJim Jagielski The PackageStream object can not be marked as encrypted one, 126*b1cdbd2cSJim Jagielski an exception will be thrown in such case. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @param aStream 129*b1cdbd2cSJim Jagielski the new raw representation of stream 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::EncryptionNotAllowedException 132*b1cdbd2cSJim Jagielski the PackageStream object is marked as encrypted 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::NoRawFormatException 135*b1cdbd2cSJim Jagielski the stream is not a correct raw representation of encrypted package stream 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 138*b1cdbd2cSJim Jagielski in case of io problems during retrieving 139*b1cdbd2cSJim Jagielski */ 140*b1cdbd2cSJim Jagielski void setRawStream( [in] ::com::sun::star::io::XInputStream aStream ) 141*b1cdbd2cSJim Jagielski raises( ::com::sun::star::packages::EncryptionNotAllowedException, 142*b1cdbd2cSJim Jagielski ::com::sun::star::packages::NoRawFormatException, 143*b1cdbd2cSJim Jagielski ::com::sun::star::io::IOException ); 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 146*b1cdbd2cSJim Jagielski /** Allows to get access to the raw data of the stream as it is stored in 147*b1cdbd2cSJim Jagielski the package. 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski @returns 150*b1cdbd2cSJim Jagielski the plain raw stream as it is stored in the package 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 153*b1cdbd2cSJim Jagielski in case of io problems during retrieving 154*b1cdbd2cSJim Jagielski */ 155*b1cdbd2cSJim Jagielski ::com::sun::star::io::XInputStream getPlainRawStream() 156*b1cdbd2cSJim Jagielski raises( ::com::sun::star::io::IOException ); 157*b1cdbd2cSJim Jagielski 158*b1cdbd2cSJim Jagielski}; 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski//============================================================================= 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski}; }; }; }; 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski/*============================================================================= 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski=============================================================================*/ 167*b1cdbd2cSJim Jagielski#endif 168