INTEGRATION: CWS jl13 (1.1.2); FILE ADDED

2004/10/21 09:27:08 sg 1.1.2.1: #116217#NEW: initial version

1 files changed, 320 insertions, 0 deletions

diff --git a/ucb/qa/complex/tdoc/interfaces/_XCommandProcessor.java b/ucb/qa/complex/tdoc/interfaces/_XCommandProcessor.java
new file mode 100755
index 000000000000..c6dbd270a5d1
--- /dev/null
+++ b/ucb/qa/complex/tdoc/interfaces/_XCommandProcessor.java
@@ -0,0 +1,320 @@
+/*************************************************************************
+ *
+ *  $RCSfile: _XCommandProcessor.java,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change:$Date: 2004-11-09 13:48:56 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+package complex.tdoc.interfaces;
+
+import com.sun.star.beans.Property;
+import com.sun.star.beans.XPropertySetInfo;
+import lib.MultiMethodTest;
+import lib.StatusException;
+
+import com.sun.star.lang.XMultiServiceFactory;
+import com.sun.star.ucb.Command;
+import com.sun.star.ucb.CommandAbortedException;
+import com.sun.star.ucb.CommandInfo;
+import com.sun.star.ucb.GlobalTransferCommandArgument;
+import com.sun.star.ucb.NameClash;
+import com.sun.star.ucb.TransferCommandOperation;
+import com.sun.star.ucb.UnsupportedCommandException;
+import com.sun.star.ucb.XCommandInfo;
+import com.sun.star.ucb.XCommandProcessor;
+import com.sun.star.uno.Exception;
+import com.sun.star.uno.UnoRuntime;
+import share.LogWriter;
+
+/**
+* Tests <code>XCommandProcessor</code>. The TestCase can pass (but doesn't have
+* to) "XCommandProcessor.AbortCommand" relation, to specify command to abort in
+* <code>abort()</code> test.
+*
+* Testing <code>com.sun.star.ucb.XCommandProcessor</code>
+* interface methods :
+* <ul>
+*  <li><code> createCommandIdentifier()</code></li>
+*  <li><code> execute()</code></li>
+*  <li><code> abort()</code></li>
+* </ul> <p>
+* This test needs the following object relations :
+* <ul>
+*  <li> <code>'XCommandProcessor.AbortCommand'</code> <b>optional</b>
+*   (of type <code>com.sun.star.ucb.Command</code>):
+*   specify command to abort in <code>abort()</code> test.
+*   If the relation is not specified the 'GlobalTransfer'
+*   command is used.</li>
+* <ul> <p>
+* The following predefined files needed to complete the test:
+* <ul>
+*  <li> <code>poliball.gif</code> : this file is required in case
+*   if the relation <code>'XCommandProcessor.AbortCommand'</code>
+*   is not specified. This file is used by 'GlobalTransfer'
+*   command as a source file for copying.</li>
+* <ul> <p>
+* Test is <b> NOT </b> multithread compilant. <p>
+* @see com.sun.star.ucb.XCommandProcessor
+*/
+public class _XCommandProcessor {
+
+    /**
+     * Conatins the tested object.
+     */
+    public XCommandProcessor oObj;
+    public LogWriter log = null;
+    private XMultiServiceFactory xMSF = null;
+
+    /**
+     * Contains the command id returned by <code>createCommandIdentifier()
+     * </code>. It is used in <code>abort()</code> test.
+     */
+    int cmdId;
+
+    public void before(XMultiServiceFactory _xMSF) {
+        xMSF = _xMSF;
+    }
+
+    /**
+     * Tests <code>createCommandIdentifier()</code>. Calls it for two times
+     * and checks returned values. <p>
+     * Has <b>OK</b> status if values are unique correct idenifiers: not 0.
+     */
+    public boolean _createCommandIdentifier() {
+        log.println("creating a command line identifier");
+
+        int testCmdId = oObj.createCommandIdentifier();
+        cmdId = oObj.createCommandIdentifier();
+
+        if (cmdId == 0 || testCmdId == 0) {
+            log.println("createCommandLineIdentifier() returned 0 - FAILED");
+        }
+
+        if (cmdId == testCmdId) {
+            log.println("the command identifier is not unique");
+        }
+
+        return testCmdId != 0 && cmdId != 0 && cmdId != testCmdId;
+    }
+
+    /**
+     * First executes 'geCommandInfo' command and examines returned
+     * command info information. Second tries to execute inproper
+     * command. <p>
+     * Has <b> OK </b> status if in the first case returned information
+     * contains info about 'getCommandInfo' command and in the second
+     * case an exception is thrown. <p>
+     */
+    public boolean _execute() {
+        String[]commands = new String[] {"getCommandInfo", "getPropertySetInfo"};
+        boolean returnVal = true;
+        for (int j=0; j<commands.length; j++) {
+            String commandName = commands[j];
+            Command command = new Command(commandName, -1, null);
+
+            Object result;
+
+            log.println("executing command " + commandName);
+            try {
+                result = oObj.execute(command, 0, null);
+            } catch (CommandAbortedException e) {
+                log.println("The command aborted " + e.getMessage());
+                e.printStackTrace((java.io.PrintWriter)log);
+                throw new StatusException("Unexpected exception", e);
+            } catch (Exception e) {
+                log.println("Unexpected exception " + e.getMessage());
+                e.printStackTrace((java.io.PrintWriter)log);
+                throw new StatusException("Unexpected exception", e);
+            }
+
+            boolean found = false;
+
+            XCommandInfo xCmdInfo = (XCommandInfo)UnoRuntime.queryInterface(
+                    XCommandInfo.class, result);
+            if (xCmdInfo != null) {
+                CommandInfo[] cmdInfo = xCmdInfo.getCommands();
+                for (int i = 0; i < cmdInfo.length; i++) {
+                    log.println("\t##### " + cmdInfo[i].Name + " - " + cmdInfo[i].Handle + " - " + cmdInfo[i].ArgType.getTypeName());
+                    if (cmdInfo[i].Name.equals(commandName)) {
+                        found = true;
+//                      break;
+                    }
+                }
+            }
+
+            XPropertySetInfo xPropInfo = (XPropertySetInfo)UnoRuntime.queryInterface(
+                    XPropertySetInfo.class, result);
+            if (xPropInfo != null) {
+                Property[] props = xPropInfo.getProperties();
+                String[] defProps = new String[] {"ContentType", "IsDocument", "IsFolder", "Title"};
+                int propCount = defProps.length;
+                for (int i = 0; i < props.length; i++) {
+                    for (int k=0; k<defProps.length; k++) {
+                        if (props[i].Name.equals(defProps[k])) {
+                            propCount--;
+                            log.println("Property '" + defProps[k] + "' has been found.");
+                        }
+                    }
+                }
+                found = propCount == 0;
+            }
+
+            returnVal &= found;
+
+            if (!found) {
+                log.println("Command '" + commandName + "' was not executed correctly.");
+            }
+        }
+/*        log.println("testing execute with wrong command");
+
+        Command badCommand = new Command("bad command", -1, null);
+
+        try {
+            oObj.execute(badCommand, 0, null);
+        } catch (CommandAbortedException e) {
+            log.println("CommandAbortedException thrown - OK");
+        } catch (UnsupportedCommandException e) {
+            log.println("UnsupportedCommandException thrown - OK");
+        } catch (Exception e) {
+            log.println("Wrong exception thrown " + e.getMessage());
+            e.printStackTrace((java.io.PrintWriter)log);
+            throw new StatusException("Unexpected exception", e);
+        }
+*/
+        return returnVal;
+    }
+
+    /**
+     * First a separate thread where <code>abort</code> method
+     * is called permanently. Then a "long" command (for example,
+     * "transfer") is started. I case if relation is not
+     * specified 'GlobalTransfer' command starts to
+     * copy a file to temporary directory (if the relation is present
+     * then the its command starts to work). <p>
+     * Has <b> OK </b> status if the command execution is aborted, i.e.
+     * <code>CommandAbortedException</code> is thrown. <p>
+     * The following method tests are to be completed successfully before :
+     * <ul>
+     *  <li> <code> createCommandIdentifier() </code> : to have a unique
+     *  identifier which is used to abourt started command. </li>
+     * </ul>
+     */
+    public boolean _abort() {
+        //executeMethod("createCommandIdentifier()");
+
+//        Command command = null;//(Command)tEnv.getObjRelation(
+                //"XCommandProcessor.AbortCommand");
+        Command command = new Command("getCommandInfo", -1, null);
+
+        if (command == null) {
+            String commandName = "globalTransfer";
+
+            String srcURL = util.utils.getFullTestURL("solibrary.jar") ;
+            String tmpURL = util.utils.getOfficeTemp(xMSF) ;
+            log.println("Copying '" + srcURL + "' to '" + tmpURL) ;
+
+            GlobalTransferCommandArgument arg = new
+                GlobalTransferCommandArgument(
+                    TransferCommandOperation.COPY, srcURL,
+                        tmpURL, "", NameClash.OVERWRITE);
+
+            command = new Command(commandName, -1, arg);
+        }
+
+        Thread aborter = new Thread() {
+            public void run() {
+                for (int i = 0; i < 10; i++) {
+                    log.println("try to abort command");
+                    oObj.abort(cmdId);
+                    try {
+                        Thread.sleep(10);
+                    } catch (InterruptedException e) {
+                    }
+                }
+            }
+        };
+
+        aborter.start();
+
+        try {
+            Thread.sleep(15);
+        } catch (InterruptedException e) {
+        }
+
+        log.println("executing command");
+        try {
+            oObj.execute(command, cmdId, null);
+            log.println("Command execution completed");
+            log.println("CommandAbortedException is not thrown");
+            log.println("This is OK since there is no command implemented "+
+                "that can be aborted");
+        } catch (CommandAbortedException e) {
+            return true;
+        } catch (Exception e) {
+            log.println("Unexpected exception " + e.getMessage());
+            e.printStackTrace((java.io.PrintWriter)log);
+            return false;
+        }
+
+        try {
+            aborter.join(5000);
+            aborter.interrupt();
+        } catch(java.lang.InterruptedException e) {
+        }
+        return true;
+    }
+}