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_embed_XStorage2_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_embed_XStorage2_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_embed_XStorage_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/embed/XStorage.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_NamedValue_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/NamedValue.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================ 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski module com { module sun { module star { module embed { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================ 40*b1cdbd2cSJim Jagielski/** This interface extends the base XStorage interface. 41*b1cdbd2cSJim Jagielski */ 42*b1cdbd2cSJim Jagielskiinterface XStorage2 : XStorage 43*b1cdbd2cSJim Jagielski{ 44*b1cdbd2cSJim Jagielski // ----------------------------------------------------------------------- 45*b1cdbd2cSJim Jagielski /** allows to get access to a child encrypted stream with EncryptionData. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski <p> 48*b1cdbd2cSJim Jagielski If storage does not allow any encryption this method will always throw 49*b1cdbd2cSJim Jagielski <type scope="com::sun::star::packages">NoEncryptionException</type>. 50*b1cdbd2cSJim Jagielski </p> 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p> 53*b1cdbd2cSJim Jagielski In case the stream is open in readonly mode the 54*b1cdbd2cSJim Jagielski <method scope="com::sun::star::io">XStream::getOutputStream</method> 55*b1cdbd2cSJim Jagielski method will return an empty reference. 56*b1cdbd2cSJim Jagielski </p> 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @param sStreamName 59*b1cdbd2cSJim Jagielski the name of the substream that should be open 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @param nOpenMode 62*b1cdbd2cSJim Jagielski a mode the stream should be open in, 63*b1cdbd2cSJim Jagielski can be a combination of <type>ElementModes</type> values 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @param aEncryptionData 66*b1cdbd2cSJim Jagielski this parameter allowes to specify an encryption data to decrypt the 67*b1cdbd2cSJim Jagielski stream, the encryption data must be correct, otherwise an 68*b1cdbd2cSJim Jagielski exception will be thrown 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @throws ::com::sun::star::embed::InvalidStorageException 71*b1cdbd2cSJim Jagielski this storage is in invalid state for any reason 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 74*b1cdbd2cSJim Jagielski one of provided arguments is illegal 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::NoEncryptionException 77*b1cdbd2cSJim Jagielski the stream is not encrypted 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::WrongPasswordException 80*b1cdbd2cSJim Jagielski the provided encryption data is wrong 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 83*b1cdbd2cSJim Jagielski in case of io errors during stream opening 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @throws ::com::sun::star::embed::StorageWrappedTargetException 86*b1cdbd2cSJim Jagielski wraps other exceptions 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski ::com::sun::star::io::XStream openEncryptedStream( 89*b1cdbd2cSJim Jagielski [in] string sStreamName, 90*b1cdbd2cSJim Jagielski [in] long nOpenMode, 91*b1cdbd2cSJim Jagielski [in] sequence< ::com::sun::star::beans::NamedValue > aEncryptionData ) 92*b1cdbd2cSJim Jagielski raises( ::com::sun::star::embed::InvalidStorageException, 93*b1cdbd2cSJim Jagielski ::com::sun::star::lang::IllegalArgumentException, 94*b1cdbd2cSJim Jagielski ::com::sun::star::packages::NoEncryptionException, 95*b1cdbd2cSJim Jagielski ::com::sun::star::packages::WrongPasswordException, 96*b1cdbd2cSJim Jagielski ::com::sun::star::io::IOException, 97*b1cdbd2cSJim Jagielski ::com::sun::star::embed::StorageWrappedTargetException ); 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski // ----------------------------------------------------------------------- 100*b1cdbd2cSJim Jagielski /** allows to get readonly copy of a child encrypted stream with encryption 101*b1cdbd2cSJim Jagielski data. 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski <p> 104*b1cdbd2cSJim Jagielski If storage does not allow any encryption this method will always throw 105*b1cdbd2cSJim Jagielski <type scope="com::sun::star::packages">NoEncryptionException</type>. 106*b1cdbd2cSJim Jagielski </p> 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski <p> 109*b1cdbd2cSJim Jagielski The stream is open in readonly mode so the 110*b1cdbd2cSJim Jagielski <method scope="com::sun::star::io">XStream::getOutputStream</method> 111*b1cdbd2cSJim Jagielski method will return an empty reference. 112*b1cdbd2cSJim Jagielski </p> 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski <p> 115*b1cdbd2cSJim Jagielski This method allows to specify encryption data for the child stream 116*b1cdbd2cSJim Jagielski explicitly. 117*b1cdbd2cSJim Jagielski </p> 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski @param sStreamName 120*b1cdbd2cSJim Jagielski the name of the substream that should be copied 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski @param aEncryptionData 123*b1cdbd2cSJim Jagielski this parameter allowes to specify an encryption data for the 124*b1cdbd2cSJim Jagielski stream, the encryption data must be correct, otherwise an 125*b1cdbd2cSJim Jagielski exception will be thrown 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski @throws ::com::sun::star::embed::InvalidStorageException 128*b1cdbd2cSJim Jagielski this storage is in invalid state for any reason 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 131*b1cdbd2cSJim Jagielski one of provided arguments is illegal 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::NoEncryptionException 134*b1cdbd2cSJim Jagielski the stream is not encrypted 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski @throws ::com::sun::star::packages::WrongPasswordException 137*b1cdbd2cSJim Jagielski the provided encryption data is wrong 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski @throws ::com::sun::star::io::IOException 140*b1cdbd2cSJim Jagielski in case of io errors during stream opening 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski @throws ::com::sun::star::embed::StorageWrappedTargetException 143*b1cdbd2cSJim Jagielski wraps other exceptions 144*b1cdbd2cSJim Jagielski */ 145*b1cdbd2cSJim Jagielski ::com::sun::star::io::XStream cloneEncryptedStream( 146*b1cdbd2cSJim Jagielski [in] string sStreamName, 147*b1cdbd2cSJim Jagielski [in] sequence< ::com::sun::star::beans::NamedValue > aEncryptionData ) 148*b1cdbd2cSJim Jagielski raises( ::com::sun::star::embed::InvalidStorageException, 149*b1cdbd2cSJim Jagielski ::com::sun::star::lang::IllegalArgumentException, 150*b1cdbd2cSJim Jagielski ::com::sun::star::packages::NoEncryptionException, 151*b1cdbd2cSJim Jagielski ::com::sun::star::packages::WrongPasswordException, 152*b1cdbd2cSJim Jagielski ::com::sun::star::io::IOException, 153*b1cdbd2cSJim Jagielski ::com::sun::star::embed::StorageWrappedTargetException ); 154*b1cdbd2cSJim Jagielski}; 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski//============================================================================ 157*b1cdbd2cSJim Jagielski 158*b1cdbd2cSJim Jagielski}; }; }; }; 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski#endif 161*b1cdbd2cSJim Jagielski 162