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_script_XLibraryContainerPassword_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_script_XLibraryContainerPassword_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_lang_IllegalArgumentException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_NoSuchElementException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/container/NoSuchElementException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski module com { module sun { module star { module script { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski/** 46*b1cdbd2cSJim Jagielski Extension of XLibraryContainer to provide password functionality. 47*b1cdbd2cSJim Jagielski This interface should be implemented together with XLibraryContainer2 48*b1cdbd2cSJim Jagielski </p> 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielskipublished interface XLibraryContainerPassword: com::sun::star::uno::XInterface 51*b1cdbd2cSJim Jagielski{ 52*b1cdbd2cSJim Jagielski /** 53*b1cdbd2cSJim Jagielski Returns true if the accessed library item is protected 54*b1cdbd2cSJim Jagielski by a password. 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski If a library with the this name doesn't exist a 57*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException is thrown. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski boolean isLibraryPasswordProtected( [in] string Name ) 60*b1cdbd2cSJim Jagielski raises( com::sun::star::container::NoSuchElementException ); 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** 63*b1cdbd2cSJim Jagielski Returns true if the accessed library item is protected by a 64*b1cdbd2cSJim Jagielski password (see isLibraryPasswordProtected) and the password 65*b1cdbd2cSJim Jagielski was already verified with verifyLibraryPassword or if an 66*b1cdbd2cSJim Jagielski initial password was set with changeLibraryPassword. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski If a library with the this name doesn't exist a 69*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException is thrown. 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski If the library exists but isn't password protected a 72*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException is thrown. 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski boolean isLibraryPasswordVerified( [in] string Name ) 75*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException, 76*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException ); 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** 79*b1cdbd2cSJim Jagielski Verifies the library's password. If the correct password 80*b1cdbd2cSJim Jagielski was passed, the method returns true and further calls to 81*b1cdbd2cSJim Jagielski isLibraryPasswordVerified will also return true. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski If a library with the this name doesn't exist a 84*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException is thrown. 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski If the library exists but isn't password protected a 87*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException is thrown. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski If the library password is already verified a 90*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException is thrown. 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski boolean verifyLibraryPassword( [in] string Name, [in] string Password ) 93*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException, 94*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException ); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski /** 97*b1cdbd2cSJim Jagielski Changes the library's password. 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski If the library wasn't password protected before: 100*b1cdbd2cSJim Jagielski The OldPassword parameter has to be an empty string. 101*b1cdbd2cSJim Jagielski Afterwards calls to isLibraryPasswordProtected and 102*b1cdbd2cSJim Jagielski isLibraryPasswordVerified for this library will 103*b1cdbd2cSJim Jagielski return true. 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski If the library already was password protected: 106*b1cdbd2cSJim Jagielski The OldPassword parameter has to be set to the 107*b1cdbd2cSJim Jagielski previous defined password. If then the NewPassword 108*b1cdbd2cSJim Jagielski parameter is an empty string the library password 109*b1cdbd2cSJim Jagielski protection will be disabled afterwards (afterwards 110*b1cdbd2cSJim Jagielski calls to isLibraryPasswordProtected for this library 111*b1cdbd2cSJim Jagielski will return false). If the NewPassword parameter is 112*b1cdbd2cSJim Jagielski not an empty string it will accepted as the new 113*b1cdbd2cSJim Jagielski password for the library. 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski If a library with the this name doesn't exist but isn't 116*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException is thrown. 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski If the library exists and is password protected and a 119*b1cdbd2cSJim Jagielski wrong OldPassword is passed to the method a 120*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException is thrown. 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski If the library exists and isn't password protected and 123*b1cdbd2cSJim Jagielski the OldPassword isn't an empty string or the library is 124*b1cdbd2cSJim Jagielski read only a 125*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException is thrown. 126*b1cdbd2cSJim Jagielski */ 127*b1cdbd2cSJim Jagielski void changeLibraryPassword( [in] string Name, 128*b1cdbd2cSJim Jagielski [in] string OldPassword, [in] string NewPassword ) 129*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException, 130*b1cdbd2cSJim Jagielski com::sun::star::container::NoSuchElementException ); 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski}; 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski//============================================================================= 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski}; }; }; }; 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski#endif 140