1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_embed_XHierarchicalStorageAccess2_idl__ 24cdf0e10cSrcweir#define __com_sun_star_embed_XHierarchicalStorageAccess2_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_embed_XHierarchicalStorageAccess_idl__ 27cdf0e10cSrcweir#include <com/sun/star/embed/XHierarchicalStorageAccess.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_NamedValue_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/NamedValue.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================ 35cdf0e10cSrcweir 36cdf0e10cSrcweir module com { module sun { module star { module embed { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================ 39cdf0e10cSrcweir/** This interface extends XHierarchicalStorageAccess interface. 40cdf0e10cSrcweir */ 41cdf0e10cSrcweirinterface XHierarchicalStorageAccess2 : XHierarchicalStorageAccess 42cdf0e10cSrcweir{ 43cdf0e10cSrcweir // ----------------------------------------------------------------------- 44cdf0e10cSrcweir /** allows to get access to a child encrypted stream with encryption data 45cdf0e10cSrcweir using hierarchical path. 46cdf0e10cSrcweir 47cdf0e10cSrcweir <p> 48cdf0e10cSrcweir If storage does not allow any encryption this method will always throw 49cdf0e10cSrcweir <type scope="com::sun::star::packages">NoEncryptionException</type>. 50cdf0e10cSrcweir </p> 51cdf0e10cSrcweir 52cdf0e10cSrcweir <p> 53cdf0e10cSrcweir In case the stream is open in readonly mode the 54cdf0e10cSrcweir <method scope="com::sun::star::io">XStream::getOutputStream</method> 55cdf0e10cSrcweir method will return an empty reference. 56cdf0e10cSrcweir </p> 57cdf0e10cSrcweir 58cdf0e10cSrcweir @param sStreamPath 59cdf0e10cSrcweir the path to the substream that should be open 60cdf0e10cSrcweir 61cdf0e10cSrcweir @param nOpenMode 62cdf0e10cSrcweir a mode the stream should be open in, 63cdf0e10cSrcweir can be a combination of <type>ElementModes</type> values 64cdf0e10cSrcweir 65cdf0e10cSrcweir @param aEncryptionData 66cdf0e10cSrcweir this parameter allowes to specify an encryption data for the 67cdf0e10cSrcweir stream, the data must be correct, otherwise an 68cdf0e10cSrcweir exception will be thrown 69cdf0e10cSrcweir 70cdf0e10cSrcweir @throws ::com::sun::star::embed::InvalidStorageException 71cdf0e10cSrcweir this storage is in invalid state for any reason 72cdf0e10cSrcweir 73cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 74cdf0e10cSrcweir one of provided arguments is illegal 75cdf0e10cSrcweir 76cdf0e10cSrcweir @throws ::com::sun::star::packages::NoEncryptionException 77cdf0e10cSrcweir the stream is not encrypted 78cdf0e10cSrcweir 79cdf0e10cSrcweir @throws ::com::sun::star::packages::WrongPasswordException 80cdf0e10cSrcweir the provided password is wrong 81cdf0e10cSrcweir 82cdf0e10cSrcweir @throws ::com::sun::star::io::IOException 83cdf0e10cSrcweir in case of io errors during stream opening 84cdf0e10cSrcweir 85cdf0e10cSrcweir @throws ::com::sun::star::embed::StorageWrappedTargetException 86cdf0e10cSrcweir wraps other exceptions 87cdf0e10cSrcweir */ 88cdf0e10cSrcweir XExtendedStorageStream openEncryptedStreamByHierarchicalName( 89cdf0e10cSrcweir [in] string sStreamName, 90cdf0e10cSrcweir [in] long nOpenMode, 91cdf0e10cSrcweir [in] sequence< ::com::sun::star::beans::NamedValue > aEncryptionData ) 92cdf0e10cSrcweir raises( ::com::sun::star::embed::InvalidStorageException, 93cdf0e10cSrcweir ::com::sun::star::lang::IllegalArgumentException, 94cdf0e10cSrcweir ::com::sun::star::packages::NoEncryptionException, 95cdf0e10cSrcweir ::com::sun::star::packages::WrongPasswordException, 96cdf0e10cSrcweir ::com::sun::star::io::IOException, 97cdf0e10cSrcweir ::com::sun::star::embed::StorageWrappedTargetException ); 98cdf0e10cSrcweir}; 99cdf0e10cSrcweir 100cdf0e10cSrcweir//============================================================================ 101cdf0e10cSrcweir 102cdf0e10cSrcweir}; }; }; }; 103cdf0e10cSrcweir 104cdf0e10cSrcweir#endif 105cdf0e10cSrcweir 106