+ * Factory that returns a Dispatch object wrapped around the result + * of a CoCreate() call. This differs from the standard constructor + * in that it throws no exceptions and returns null on failure. + *
+ * This will fail for any prog id with a ":" in it. + * + * @param pRequestedProgramId + * @return Dispatch pointer to the COM object or null if couldn't create + */ + public static ActiveXComponent createNewInstance(String pRequestedProgramId){ + ActiveXComponent mCreatedDispatch = null; + try { + mCreatedDispatch = new ActiveXComponent(); + mCreatedDispatch.coCreateInstanceJava(pRequestedProgramId); + } catch (Exception e){ + mCreatedDispatch =null; + if (JacobObject.isDebugEnabled()){ + JacobObject.debug("Unable to co-create instance of "+pRequestedProgramId); + } + } + return mCreatedDispatch; + } + + /** + * Most code should use the standard ActiveXComponent(String) contructor + * and not this factory method. This method exists for applications + * that need special behavior. + * Experimental in release 1.9.2. + *
+ * Factory that returns a Dispatch wrapped around the result + * of a getActiveObject() call. This differs from the standard constructor + * in that it throws no exceptions and returns null on failure. + *
+ * This will fail for any prog id with a ":" in it + * + * @param pRequestedProgramId + * @return Dispatch pointer to a COM object or null if wasn't already running + */ + public static ActiveXComponent connectToActiveInstance(String pRequestedProgramId){ + ActiveXComponent mCreatedDispatch = null; + try { + mCreatedDispatch = new ActiveXComponent(); + mCreatedDispatch.getActiveInstanceJava(pRequestedProgramId); + } catch (Exception e){ + mCreatedDispatch =null; + if (JacobObject.isDebugEnabled()){ + JacobObject.debug("Unable to attach to running instance of "+pRequestedProgramId); + } + } + return mCreatedDispatch; + } + /** * @see com.jacob.com.Dispatch#finalize() */ diff --git a/src/com/jacob/com/Dispatch.java b/src/com/jacob/com/Dispatch.java index 3d8d277..dadb062 100644 --- a/src/com/jacob/com/Dispatch.java +++ b/src/com/jacob/com/Dispatch.java @@ -150,11 +150,18 @@ public class Dispatch extends JacobObject * This constructor always creates a new windows/program object * because it is based on the CoCreate() windows function. *
+ * Fails silently if null is passed in as the program id + *
* @param requestedProgramId */ public Dispatch(String requestedProgramId) { programId = requestedProgramId; - createInstance(requestedProgramId); + if (programId != null && !"".equals(programId)){ + createInstance(requestedProgramId); + } else { + throw new IllegalArgumentException( + "Dispatch(String) does not accept null or an empty string as a parameter"); + } } /** @@ -163,10 +170,59 @@ public class Dispatch extends JacobObject * Windows CoCreate() call *
* This ends up calling CoCreate down in the JNI layer + *
+ * The behavior is different if a ":" character exists in the progId. In that + * case CoGetObject and CreateInstance (someone needs to describe this better) * * @param progid */ - protected native void createInstance(String progid); + private native void createInstance(String progid); + + /** + * native call getActiveInstance only used by the constructor with the same parm + * type. This probably should be private. It is the wrapper for the + * Windows GetActiveObject() call + *
+ * This ends up calling GetActiveObject down in the JNI layer + *
+ * This does not have the special behavior for program ids with ":" in them + * that createInstance has. + * + * @param progid + */ + private native void getActiveInstance(String progid); + + /** + * Wrapper around the native method + * @param progid + */ + protected void getActiveInstanceJava(String progid){ + this.programId = progid; + getActiveInstance(progid); + } + + /** + * native call coCreateInstance only used by the constructor with the same parm + * type. This probably should be private. It is the wrapper for the + * Windows CoCreate() call + *
+ * This ends up calling CoCreate down in the JNI layer + *
+ * This does not have the special behavior for program ids with ":" in them + * that createInstance has. + * + * @param progid + */ + private native void coCreateInstance(String progid); + + /** + * Wrapper around the native method + * @param progid + */ + protected void coCreateInstanceJava(String progid){ + this.programId = progid; + coCreateInstance(progid); + } /** * Return a different interface by IID string. diff --git a/unittest/com/jacob/com/ActiveXComponentFactoryTest.java b/unittest/com/jacob/com/ActiveXComponentFactoryTest.java new file mode 100644 index 0000000..a9dbcbb --- /dev/null +++ b/unittest/com/jacob/com/ActiveXComponentFactoryTest.java @@ -0,0 +1,60 @@ +package com.jacob.com; + +import com.jacob.activeX.ActiveXComponent; + +/** + * This exercises the two Dispatch factor methods that let you + * control whether you create a new running COM object or connect to an existing one + * + * -Djava.library.path=d:/jacob/release -Dcom.jacob.autogc=false -Dcom.jacob.debug=true + * + * @author joe + * + */ +public class ActiveXComponentFactoryTest { + public static void main(String args[]) throws Exception { + ComThread.InitSTA(true); + try { + System.out.println("This test only works if MS Word is NOT already running"); + String mApplicationId = "Word.Application"; + ActiveXComponent mTryConnectingFirst = ActiveXComponent.connectToActiveInstance(mApplicationId); + if (mTryConnectingFirst != null ){ + mTryConnectingFirst.invoke("Quit",new Variant[] {}); + System.out.println("Was able to connect to MSWord when hadn't started it"); + } else { + System.out.println("Correctly could not connect to running MSWord"); + } + System.out.println(" Word Starting"); + ActiveXComponent mTryStartingSecond = ActiveXComponent.createNewInstance(mApplicationId); + if (mTryStartingSecond == null){ + System.out.println("was unable to start up MSWord "); + } else { + System.out.println("Correctly could start MSWord"); + } + ActiveXComponent mTryConnectingThird = ActiveXComponent.connectToActiveInstance(mApplicationId); + if (mTryConnectingThird == null ){ + System.out.println("was unable able to connect to MSWord after previous startup"); + } else { + System.out.println("Correctly could connect to running MSWord"); + // stop it so we can fail trying to connect to a running + mTryConnectingThird.invoke("Quit",new Variant[] {}); + System.out.println(" Word stopped"); + } + Thread.sleep(2000); + ActiveXComponent mTryConnectingFourth = ActiveXComponent.connectToActiveInstance(mApplicationId); + if (mTryConnectingFourth != null ){ + System.out.println("Was able to connect to MSWord that was stopped"); + mTryConnectingFourth.invoke("Quit",new Variant[] {}); + } else { + System.out.println("Correctly could not connect to running MSWord"); + } + } catch (ComException e) { + e.printStackTrace(); + } finally { + System.out.println("About to sleep for 2 seconds so we can bask in the glory of this success"); + Thread.sleep(2000); + ComThread.Release(); + ComThread.quitMainSTA(); + } + } +} diff --git a/unittest/com/jacob/com/DispatchNullProgramId.java b/unittest/com/jacob/com/DispatchNullProgramId.java new file mode 100644 index 0000000..3861b28 --- /dev/null +++ b/unittest/com/jacob/com/DispatchNullProgramId.java @@ -0,0 +1,32 @@ +package com.jacob.com; + +/** + * This test verifies that the Dispatch object protects itself when + * the constructor is called with a null program id. + * Prior to this protection, the VM might crash.m + * @author joe + * + */ +public class DispatchNullProgramId { + + public static void main(String[] args) { + try { + String nullParam = null; + new Dispatch(nullParam); + System.out.println( + "the dispatch failed to protect itself from null program ids"); + } catch (IllegalArgumentException iae){ + System.out.println( + "the dispatch protected itself from null program ids"); + } + try { + String nullParam = ""; + new Dispatch(nullParam); + System.out.println( + "the dispatch failed to protect itself from empty string program ids"); + } catch (IllegalArgumentException iae){ + System.out.println( + "the dispatch protected itself from empty string program ids"); + } + } +} diff --git a/unittest/com/jacob/com/ExcelEventTest.java b/unittest/com/jacob/com/ExcelEventTest.java new file mode 100644 index 0000000..b3bf9c4 --- /dev/null +++ b/unittest/com/jacob/com/ExcelEventTest.java @@ -0,0 +1,50 @@ +package com.jacob.com; + +import com.jacob.activeX.ActiveXComponent; +import com.jacob.com.ComFailException; +import com.jacob.com.DispatchEvents; + +/** + * This test was lifted from a forum posting and shows how you can't listen to + * Excel events added post 1.9.1 Eclipse Settings... + * -Djava.library.path=d:/jacob/release -Dcom.jacob.autogc=false + * -Dcom.jacob.debug=true + */ +public class ExcelEventTest { + + public static void main(String args[]) { + + listenTo("Word.Application",null); + + // Create an Excel Listener + listenTo("Excel.Application", + "C:\\Program Files\\Microsoft Office\\OFFICE11\\EXCEL.EXE"); + } + + private static void listenTo(String pid, String typeLibLocation) { + + // Grab The Component. + ActiveXComponent axc = new ActiveXComponent(pid); + try { + // Add a listener (doesn't matter what it is). + DispatchEvents de; + if (typeLibLocation == null){ + de = new DispatchEvents(axc, new ExcelEventTest()); + } else { + de = new DispatchEvents(axc, new ExcelEventTest(), + pid,typeLibLocation); + } + if (de == null){ + System.out.println( + "No exception thrown but now dispatch returned for Excel events"); + } + // Yea! + System.out.println("Successfully attached to " + pid); + } catch (ComFailException e) { + e.printStackTrace(); + System.out.println("Failed to attach to " + pid + ": " + + e.getMessage()); + + } + } +}