1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir package ifc.ucb; 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir import lib.MultiMethodTest; 31*cdf0e10cSrcweir import lib.Status; 32*cdf0e10cSrcweir import lib.StatusException; 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir import com.sun.star.lang.XMultiServiceFactory; 35*cdf0e10cSrcweir import com.sun.star.ucb.ContentProviderInfo; 36*cdf0e10cSrcweir import com.sun.star.ucb.DuplicateProviderException; 37*cdf0e10cSrcweir import com.sun.star.ucb.XContentProvider; 38*cdf0e10cSrcweir import com.sun.star.ucb.XContentProviderManager; 39*cdf0e10cSrcweir import com.sun.star.uno.Exception; 40*cdf0e10cSrcweir import com.sun.star.uno.UnoRuntime; 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir /** 43*cdf0e10cSrcweir * Tests XContentProviderManager. The test registers two ContentProviders, calls 44*cdf0e10cSrcweir * queryXXX methods to verify results, and deregisters them. 45*cdf0e10cSrcweir * 46*cdf0e10cSrcweir * Testing <code>com.sun.star.ucb.XContentProviderManager</code> 47*cdf0e10cSrcweir * interface methods : 48*cdf0e10cSrcweir * <ul> 49*cdf0e10cSrcweir * <li><code> registerContentProvider()</code></li> 50*cdf0e10cSrcweir * <li><code> deregisterContentProvider()</code></li> 51*cdf0e10cSrcweir * <li><code> queryContentProviders()</code></li> 52*cdf0e10cSrcweir * <li><code> queryContentProvider()</code></li> 53*cdf0e10cSrcweir * </ul> <p> 54*cdf0e10cSrcweir * The test registers two ContentProviders, calls 55*cdf0e10cSrcweir * queryXXX methods to verify results, and deregisters them. <p> 56*cdf0e10cSrcweir * 57*cdf0e10cSrcweir * Test is <b> NOT </b> multithread compilant. <p> 58*cdf0e10cSrcweir * @see com.sun.star.ucb.XContentProviderManager 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir public class _XContentProviderManager extends MultiMethodTest { 61*cdf0e10cSrcweir /** 62*cdf0e10cSrcweir * Contains the tested object. 63*cdf0e10cSrcweir */ 64*cdf0e10cSrcweir public XContentProviderManager oObj; 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir /** 67*cdf0e10cSrcweir * The test scheme name. 68*cdf0e10cSrcweir */ 69*cdf0e10cSrcweir static final String myScheme = "test-scheme"; 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir /** 72*cdf0e10cSrcweir * First content provider. It will be hidden by <code>contentProvider 73*cdf0e10cSrcweir * </code>, registred with the same <code>myScheme</code> to test 74*cdf0e10cSrcweir * the "hiding" behaviour. 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir XContentProvider firstContentProvider; 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir /** 79*cdf0e10cSrcweir * The main content provider. 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir XContentProvider contentProvider; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir /** 84*cdf0e10cSrcweir * <code>ContentProvider</code>s information which are in the manager 85*cdf0e10cSrcweir * before registering the testing providers. 86*cdf0e10cSrcweir */ 87*cdf0e10cSrcweir ContentProviderInfo[] initialProvidersInfo; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir /** 90*cdf0e10cSrcweir * Creates two testing providers. 91*cdf0e10cSrcweir * 92*cdf0e10cSrcweir * @see #firstContentProvider 93*cdf0e10cSrcweir * @see #contentProvider 94*cdf0e10cSrcweir */ 95*cdf0e10cSrcweir public void before() { 96*cdf0e10cSrcweir XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF(); 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir log.println("creating testing content providers"); 99*cdf0e10cSrcweir try { 100*cdf0e10cSrcweir firstContentProvider = (XContentProvider)UnoRuntime.queryInterface( 101*cdf0e10cSrcweir XContentProvider.class, xMSF.createInstance( 102*cdf0e10cSrcweir "com.sun.star.ucb.FileContentProvider")); 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir contentProvider = (XContentProvider)UnoRuntime.queryInterface( 105*cdf0e10cSrcweir XContentProvider.class, xMSF.createInstance( 106*cdf0e10cSrcweir "com.sun.star.ucb.FileContentProvider")); 107*cdf0e10cSrcweir } catch (Exception e) { 108*cdf0e10cSrcweir log.println("Can't create content providers " + e.getMessage()); 109*cdf0e10cSrcweir e.printStackTrace(log); 110*cdf0e10cSrcweir throw new StatusException("Unexpected exception", e); 111*cdf0e10cSrcweir } 112*cdf0e10cSrcweir } 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir /** 115*cdf0e10cSrcweir * At the beginning call <code>queryContentProviders</code> method 116*cdf0e10cSrcweir * 117*cdf0e10cSrcweir * to have info about providers existing before new adding. 118*cdf0e10cSrcweir * It adds two testing contents providers, both for the same scheme. 119*cdf0e10cSrcweir * The second one is added two times: first, in non-replacing mode, to test 120*cdf0e10cSrcweir * <code>DuplicateProviderException</code>, and second, in replacing mode, 121*cdf0e10cSrcweir * to hide the first provider. <p> 122*cdf0e10cSrcweir * 123*cdf0e10cSrcweir * The evaluation of results are performed later, in 124*cdf0e10cSrcweir * <code>queryContentProvider()</code>. 125*cdf0e10cSrcweir * 126*cdf0e10cSrcweir * Has <b> OK </b> status if in the first provider is registered 127*cdf0e10cSrcweir * without exceptions, the second throws 128*cdf0e10cSrcweir * <code>DuplicateProviderException</code> in non-replacing mode, 129*cdf0e10cSrcweir * and no exceptions in replacing mode. <p> 130*cdf0e10cSrcweir * 131*cdf0e10cSrcweir * @see #_queryContentProvider 132*cdf0e10cSrcweir */ 133*cdf0e10cSrcweir public void _registerContentProvider() { 134*cdf0e10cSrcweir // querying providfers info before inserting them, to verify results 135*cdf0e10cSrcweir initialProvidersInfo = oObj.queryContentProviders(); 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir log.println("registering the first provider"); 138*cdf0e10cSrcweir try { 139*cdf0e10cSrcweir oObj.registerContentProvider(firstContentProvider, myScheme,false); 140*cdf0e10cSrcweir } catch (DuplicateProviderException e) { 141*cdf0e10cSrcweir log.println("Unexpected exception thrown " + e.getMessage()); 142*cdf0e10cSrcweir e.printStackTrace(log); 143*cdf0e10cSrcweir throw new StatusException("Unexpected exception ", e); 144*cdf0e10cSrcweir } 145*cdf0e10cSrcweir 146*cdf0e10cSrcweir log.println("registering the second provider in non-replacing mode"); 147*cdf0e10cSrcweir try { 148*cdf0e10cSrcweir oObj.registerContentProvider(contentProvider, myScheme, false); 149*cdf0e10cSrcweir Status.failed("registerContentProvider(.., .., false)"); 150*cdf0e10cSrcweir } catch (DuplicateProviderException e) { 151*cdf0e10cSrcweir log.println("DuplicateProviderException thrown - OK"); 152*cdf0e10cSrcweir } 153*cdf0e10cSrcweir 154*cdf0e10cSrcweir XContentProvider result; 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir log.println("registering the second provider in the replace mode"); 157*cdf0e10cSrcweir try { 158*cdf0e10cSrcweir result = oObj.registerContentProvider(contentProvider, myScheme, true); 159*cdf0e10cSrcweir } catch (DuplicateProviderException e) { 160*cdf0e10cSrcweir log.println("Unexpected exception thrown " + e.getMessage()); 161*cdf0e10cSrcweir e.printStackTrace(log); 162*cdf0e10cSrcweir throw new StatusException("Unexpected exception ", e); 163*cdf0e10cSrcweir } 164*cdf0e10cSrcweir 165*cdf0e10cSrcweir // check the result is the first provider 166*cdf0e10cSrcweir tRes.tested("registerContentProvider()", 167*cdf0e10cSrcweir result.equals(firstContentProvider)); 168*cdf0e10cSrcweir } 169*cdf0e10cSrcweir 170*cdf0e10cSrcweir /** 171*cdf0e10cSrcweir * It calls the method (after registering providers) and compares 172*cdf0e10cSrcweir * its result with the result before registering. 173*cdf0e10cSrcweir * 174*cdf0e10cSrcweir * Has <b> OK </b> status if the number of providers increases 175*cdf0e10cSrcweir * by one after registering custom provider. 176*cdf0e10cSrcweir * 177*cdf0e10cSrcweir * The following method tests are to be completed successfully before : 178*cdf0e10cSrcweir * <ul> 179*cdf0e10cSrcweir * <li> <code> registerContentProvider() </code> : to compare number 180*cdf0e10cSrcweir * of providers. </li> 181*cdf0e10cSrcweir * </ul> 182*cdf0e10cSrcweir * @see #_registerContentProvider 183*cdf0e10cSrcweir */ 184*cdf0e10cSrcweir public void _queryContentProviders() { 185*cdf0e10cSrcweir executeMethod("registerContentProvider()"); 186*cdf0e10cSrcweir 187*cdf0e10cSrcweir ContentProviderInfo[] providersInfo = oObj.queryContentProviders(); 188*cdf0e10cSrcweir // verifying that the number of providers increased by 1 189*cdf0e10cSrcweir tRes.tested("queryContentProviders()", 190*cdf0e10cSrcweir providersInfo.length == initialProvidersInfo.length + 1); 191*cdf0e10cSrcweir } 192*cdf0e10cSrcweir 193*cdf0e10cSrcweir /** 194*cdf0e10cSrcweir * It queries for added custom provider using its scheme 195*cdf0e10cSrcweir * and verifies its result with 196*cdf0e10cSrcweir * <code>queryContentProviders()</code> result and with 197*cdf0e10cSrcweir * custom provider created in <code>registerContentProvider()</code>. 198*cdf0e10cSrcweir * Also verifies <code>registerContentProvider()</code>. <p> 199*cdf0e10cSrcweir * 200*cdf0e10cSrcweir * Has <b>OK</b> status if the provider returned is found within 201*cdf0e10cSrcweir * all providers and is equal to provider created before. 202*cdf0e10cSrcweir * 203*cdf0e10cSrcweir * The following method tests are to be completed successfully before : 204*cdf0e10cSrcweir * <ul> 205*cdf0e10cSrcweir * <li> <code> registerContentProvider() </code> </li> 206*cdf0e10cSrcweir * </ul> 207*cdf0e10cSrcweir */ 208*cdf0e10cSrcweir public void _queryContentProvider() { 209*cdf0e10cSrcweir executeMethod("registerContentProvider()"); 210*cdf0e10cSrcweir 211*cdf0e10cSrcweir XContentProvider result = oObj.queryContentProvider 212*cdf0e10cSrcweir ("http://www.sun.com"); 213*cdf0e10cSrcweir 214*cdf0e10cSrcweir log.println("finding queryContentProvider() result"); 215*cdf0e10cSrcweir boolean found = false; 216*cdf0e10cSrcweir 217*cdf0e10cSrcweir ContentProviderInfo[] providersInfo = oObj.queryContentProviders(); 218*cdf0e10cSrcweir 219*cdf0e10cSrcweir for (int i = 0; i < providersInfo.length; i++) { 220*cdf0e10cSrcweir if (result.equals(providersInfo[i].ContentProvider) 221*cdf0e10cSrcweir /*&& myScheme.equals(providersInfo[i].Scheme)*/) { 222*cdf0e10cSrcweir found = true; 223*cdf0e10cSrcweir break; 224*cdf0e10cSrcweir } 225*cdf0e10cSrcweir } 226*cdf0e10cSrcweir 227*cdf0e10cSrcweir // boolean gotTheRightOne = util.ValueComparer.equalValue 228*cdf0e10cSrcweir // (result,contentProvider); 229*cdf0e10cSrcweir 230*cdf0e10cSrcweir tRes.tested("queryContentProvider()", found); 231*cdf0e10cSrcweir 232*cdf0e10cSrcweir // gotTheRightOne = result.equals(contentProvider); 233*cdf0e10cSrcweir 234*cdf0e10cSrcweir } 235*cdf0e10cSrcweir 236*cdf0e10cSrcweir /** 237*cdf0e10cSrcweir * At first one provider is deregistered, after that provider 238*cdf0e10cSrcweir * is queried, the second provider must be returned for the 239*cdf0e10cSrcweir * specified scheme. Then the second provider is deregistered. 240*cdf0e10cSrcweir * Now <code>null</code> value must be retruned by the method 241*cdf0e10cSrcweir * <code>queryContentProvider</code> on the specified scheme. <p> 242*cdf0e10cSrcweir * 243*cdf0e10cSrcweir * Has <b>OK</b> status if in the first case the second provider 244*cdf0e10cSrcweir * remains registered, and after its removing no providers remain 245*cdf0e10cSrcweir * registered for the scheme specified. 246*cdf0e10cSrcweir * 247*cdf0e10cSrcweir * The following method tests are to be completed successfully before : 248*cdf0e10cSrcweir * <ul> 249*cdf0e10cSrcweir * <li> <code> registerContentProvider() </code> : two providers 250*cdf0e10cSrcweir * must be registered. </li> 251*cdf0e10cSrcweir * </ul> 252*cdf0e10cSrcweir * The following method tests are to be executed before : 253*cdf0e10cSrcweir * <ul> 254*cdf0e10cSrcweir * <li> <code> queryContentProvider() </code> : to run this test 255*cdf0e10cSrcweir * finally. </li> 256*cdf0e10cSrcweir * <li> <code> queryContentProviders() </code> : to run this test 257*cdf0e10cSrcweir * finally. </li> 258*cdf0e10cSrcweir * </ul> 259*cdf0e10cSrcweir */ 260*cdf0e10cSrcweir public void _deregisterContentProvider() { 261*cdf0e10cSrcweir executeMethod("queryContentProvider()"); 262*cdf0e10cSrcweir executeMethod("queryContentProviders()"); 263*cdf0e10cSrcweir requiredMethod("registerContentProvider()"); 264*cdf0e10cSrcweir 265*cdf0e10cSrcweir log.println("deregistering the second provider"); 266*cdf0e10cSrcweir oObj.deregisterContentProvider(contentProvider, myScheme); 267*cdf0e10cSrcweir 268*cdf0e10cSrcweir XContentProvider res = oObj.queryContentProvider(myScheme); 269*cdf0e10cSrcweir 270*cdf0e10cSrcweir log.println("deregistering the first provider"); 271*cdf0e10cSrcweir oObj.deregisterContentProvider(firstContentProvider, myScheme); 272*cdf0e10cSrcweir 273*cdf0e10cSrcweir res = oObj.queryContentProvider(myScheme); 274*cdf0e10cSrcweir 275*cdf0e10cSrcweir // verifying that no provider is returned 276*cdf0e10cSrcweir tRes.tested("deregisterContentProvider()", res == null); 277*cdf0e10cSrcweir } 278*cdf0e10cSrcweir } 279