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_XHierarchicalStorageAccess_idl__ 24cdf0e10cSrcweir#define __com_sun_star_embed_XHierarchicalStorageAccess_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_io_XStream_idl__ 31cdf0e10cSrcweir#include <com/sun/star/io/XStream.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_embed_XExtendedStorageStream_idl__ 35cdf0e10cSrcweir#include <com/sun/star/embed/XExtendedStorageStream.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_io_IOException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/io/IOException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 43cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_embed_StorageWrappedTargetException_idl__ 47cdf0e10cSrcweir#include <com/sun/star/embed/StorageWrappedTargetException.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir#ifndef __com_sun_star_embed_InvalidStorageException_idl__ 51cdf0e10cSrcweir#include <com/sun/star/embed/InvalidStorageException.idl> 52cdf0e10cSrcweir#endif 53cdf0e10cSrcweir 54cdf0e10cSrcweir#ifndef __com_sun_star_packages_WrongPasswordException_idl__ 55cdf0e10cSrcweir#include <com/sun/star/packages/WrongPasswordException.idl> 56cdf0e10cSrcweir#endif 57cdf0e10cSrcweir 58cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__ 59cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl> 60cdf0e10cSrcweir#endif 61cdf0e10cSrcweir 62cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__ 63cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl> 64cdf0e10cSrcweir#endif 65cdf0e10cSrcweir 66cdf0e10cSrcweir#ifndef __com_sun_star_container_ElementExistException_idl__ 67cdf0e10cSrcweir#include <com/sun/star/container/ElementExistException.idl> 68cdf0e10cSrcweir#endif 69cdf0e10cSrcweir 70cdf0e10cSrcweir#ifndef __com_sun_star_packages_NoEncryptionException_idl__ 71cdf0e10cSrcweir#include <com/sun/star/packages/NoEncryptionException.idl> 72cdf0e10cSrcweir#endif 73cdf0e10cSrcweir 74cdf0e10cSrcweir 75cdf0e10cSrcweir//============================================================================ 76cdf0e10cSrcweir 77cdf0e10cSrcweir module com { module sun { module star { module embed { 78cdf0e10cSrcweir 79cdf0e10cSrcweir//============================================================================ 80cdf0e10cSrcweir/** This interface allows hierarchical access to storage tree. 81cdf0e10cSrcweir 82cdf0e10cSrcweir <p> 83cdf0e10cSrcweir Currently only streams can be opened using this interface. 84cdf0e10cSrcweir </p> 85cdf0e10cSrcweir 86cdf0e10cSrcweir <p> 87cdf0e10cSrcweir The hierarchical access can not be mixed with a normal access. Thus when 88cdf0e10cSrcweir in a storage a stream with a path "a/b/c" is accessed using hierarchical 89cdf0e10cSrcweir access, another stream "a/b/d" can also be opened with hierarchical 90cdf0e10cSrcweir access ( if it is still not opened ), but the substorage "a" can not be 91cdf0e10cSrcweir opened ( it is locked by hierarchical access ). 92cdf0e10cSrcweir </p> 93cdf0e10cSrcweir */ 94cdf0e10cSrcweirpublished interface XHierarchicalStorageAccess 95cdf0e10cSrcweir{ 96cdf0e10cSrcweir // METHODS 97cdf0e10cSrcweir // 98cdf0e10cSrcweir // ----------------------------------------------------------------------- 99cdf0e10cSrcweir /** allows to get access to a child stream of the storage, using 100cdf0e10cSrcweir hierarchical path. 101cdf0e10cSrcweir 102cdf0e10cSrcweir <p> 103cdf0e10cSrcweir In case the stream is open in readonly mode the 104cdf0e10cSrcweir <method scope="com::sun::star::io">XStream::getOutputStream</method> 105cdf0e10cSrcweir method will return an empty reference. 106cdf0e10cSrcweir </p> 107cdf0e10cSrcweir 108cdf0e10cSrcweir @param sStreamPath 109cdf0e10cSrcweir the path to the substream that should be open 110cdf0e10cSrcweir 111cdf0e10cSrcweir @param nOpenMode 112cdf0e10cSrcweir a mode the stream should be open in, 113cdf0e10cSrcweir can be a combination of <type>ElementModes</type> values 114cdf0e10cSrcweir 115cdf0e10cSrcweir @throws ::com::sun::star::embed::InvalidStorageException 116cdf0e10cSrcweir this storage is in invalid state for any reason 117cdf0e10cSrcweir 118cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 119cdf0e10cSrcweir one of provided arguments is illegal 120cdf0e10cSrcweir 121cdf0e10cSrcweir @throws ::com::sun::star::packages::WrongPasswordException 122cdf0e10cSrcweir the provided password is wrong 123cdf0e10cSrcweir 124cdf0e10cSrcweir @throws ::com::sun::star::io::IOException 125cdf0e10cSrcweir in case of io errors during stream opening 126cdf0e10cSrcweir 127cdf0e10cSrcweir @throws ::com::sun::star::embed::StorageWrappedTargetException 128cdf0e10cSrcweir wraps other exceptions 129cdf0e10cSrcweir */ 130cdf0e10cSrcweir XExtendedStorageStream openStreamElementByHierarchicalName( 131cdf0e10cSrcweir [in] string sStreamPath, 132cdf0e10cSrcweir [in] long nOpenMode ) 133cdf0e10cSrcweir raises( ::com::sun::star::embed::InvalidStorageException, 134cdf0e10cSrcweir ::com::sun::star::lang::IllegalArgumentException, 135cdf0e10cSrcweir ::com::sun::star::packages::WrongPasswordException, 136cdf0e10cSrcweir ::com::sun::star::io::IOException, 137cdf0e10cSrcweir ::com::sun::star::embed::StorageWrappedTargetException ); 138cdf0e10cSrcweir 139cdf0e10cSrcweir // ----------------------------------------------------------------------- 140cdf0e10cSrcweir /** allows to get access to a child encrypted stream with password using 141cdf0e10cSrcweir hierarchical path. 142cdf0e10cSrcweir 143cdf0e10cSrcweir <p> 144cdf0e10cSrcweir If storage does not allow any encryption this method will always throw 145cdf0e10cSrcweir <type scope="com::sun::star::packages">NoEncryptionException</type>. 146cdf0e10cSrcweir </p> 147cdf0e10cSrcweir 148cdf0e10cSrcweir <p> 149cdf0e10cSrcweir In case the stream is open in readonly mode the 150cdf0e10cSrcweir <method scope="com::sun::star::io">XStream::getOutputStream</method> 151cdf0e10cSrcweir method will return an empty reference. 152cdf0e10cSrcweir </p> 153cdf0e10cSrcweir 154cdf0e10cSrcweir @param sStreamPath 155cdf0e10cSrcweir the path to the substream that should be open 156cdf0e10cSrcweir 157cdf0e10cSrcweir @param nOpenMode 158cdf0e10cSrcweir a mode the stream should be open in, 159cdf0e10cSrcweir can be a combination of <type>ElementModes</type> values 160cdf0e10cSrcweir 161cdf0e10cSrcweir @param sPassword 162cdf0e10cSrcweir this parameter allowes to specify a reading password for the 163cdf0e10cSrcweir stream, the password must be a correct one, otherwise an 164cdf0e10cSrcweir exception will be thrown 165cdf0e10cSrcweir 166cdf0e10cSrcweir @throws ::com::sun::star::embed::InvalidStorageException 167cdf0e10cSrcweir this storage is in invalid state for any reason 168cdf0e10cSrcweir 169cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 170cdf0e10cSrcweir one of provided arguments is illegal 171cdf0e10cSrcweir 172cdf0e10cSrcweir @throws ::com::sun::star::packages::NoEncryptionException 173cdf0e10cSrcweir the stream is not encrypted 174cdf0e10cSrcweir 175cdf0e10cSrcweir @throws ::com::sun::star::packages::WrongPasswordException 176cdf0e10cSrcweir the provided password is wrong 177cdf0e10cSrcweir 178cdf0e10cSrcweir @throws ::com::sun::star::io::IOException 179cdf0e10cSrcweir in case of io errors during stream opening 180cdf0e10cSrcweir 181cdf0e10cSrcweir @throws ::com::sun::star::embed::StorageWrappedTargetException 182cdf0e10cSrcweir wraps other exceptions 183cdf0e10cSrcweir */ 184cdf0e10cSrcweir XExtendedStorageStream openEncryptedStreamElementByHierarchicalName( 185cdf0e10cSrcweir [in] string sStreamName, 186cdf0e10cSrcweir [in] long nOpenMode, 187cdf0e10cSrcweir [in] string sPassword ) 188cdf0e10cSrcweir raises( ::com::sun::star::embed::InvalidStorageException, 189cdf0e10cSrcweir ::com::sun::star::lang::IllegalArgumentException, 190cdf0e10cSrcweir ::com::sun::star::packages::NoEncryptionException, 191cdf0e10cSrcweir ::com::sun::star::packages::WrongPasswordException, 192cdf0e10cSrcweir ::com::sun::star::io::IOException, 193cdf0e10cSrcweir ::com::sun::star::embed::StorageWrappedTargetException ); 194cdf0e10cSrcweir 195cdf0e10cSrcweir // ----------------------------------------------------------------------- 196cdf0e10cSrcweir /** removes a stream specified by hierarchical name from a storage. 197cdf0e10cSrcweir 198cdf0e10cSrcweir @param sElementPath 199cdf0e10cSrcweir the path to the element to remove 200cdf0e10cSrcweir 201cdf0e10cSrcweir @throws ::com::sun::star::embed::InvalidStorageException 202cdf0e10cSrcweir this storage is in invalid state for eny reason 203cdf0e10cSrcweir 204cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 205cdf0e10cSrcweir an illegal argument is provided 206cdf0e10cSrcweir 207cdf0e10cSrcweir @throws ::com::sun::star::container::NoSuchElementException 208cdf0e10cSrcweir there is no element with such name 209cdf0e10cSrcweir 210cdf0e10cSrcweir @throws ::com::sun::star::io::IOException 211cdf0e10cSrcweir in case of io errors during removing 212cdf0e10cSrcweir 213cdf0e10cSrcweir @throws ::com::sun::star::embed::StorageWrappedTargetException 214cdf0e10cSrcweir wraps other exceptions 215cdf0e10cSrcweir 216cdf0e10cSrcweir */ 217cdf0e10cSrcweir void removeStreamElementByHierarchicalName( [in] string sElementPath ) 218cdf0e10cSrcweir raises( ::com::sun::star::embed::InvalidStorageException, 219cdf0e10cSrcweir ::com::sun::star::lang::IllegalArgumentException, 220cdf0e10cSrcweir ::com::sun::star::container::NoSuchElementException, 221cdf0e10cSrcweir ::com::sun::star::io::IOException, 222cdf0e10cSrcweir ::com::sun::star::embed::StorageWrappedTargetException ); 223cdf0e10cSrcweir 224cdf0e10cSrcweir}; 225cdf0e10cSrcweir 226cdf0e10cSrcweir//============================================================================ 227cdf0e10cSrcweir 228cdf0e10cSrcweir}; }; }; }; 229cdf0e10cSrcweir 230cdf0e10cSrcweir#endif 231cdf0e10cSrcweir 232