INTEGRATION: CWS sb31 (1.1.2); FILE ADDED

2005/04/07 13:48:49 sb 1.1.2.2: #120220# Fixed copyright statement.
2005/04/07 12:16:31 sb 1.1.2.1: #120220# Added an encapsulating wrapper around a Java virtual machine and an appropriate UNO class loader.

1 files changed, 149 insertions, 0 deletions

diff --git a/jvmaccess/inc/jvmaccess/unovirtualmachine.hxx b/jvmaccess/inc/jvmaccess/unovirtualmachine.hxx
new file mode 100644
index 000000000000..235d52fc6321
--- /dev/null
+++ b/jvmaccess/inc/jvmaccess/unovirtualmachine.hxx
@@ -0,0 +1,149 @@
+/*************************************************************************
+ *
+ *  $RCSfile: unovirtualmachine.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2005-06-17 09:20:20 $
+ *
+ *  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: 2005 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef INCLUDED_JVMACCESS_UNOVIRTUALMACHINE_HXX
+#define INCLUDED_JVMACCESS_UNOVIRTUALMACHINE_HXX
+
+#ifndef _SAL_CONFIG_H_
+#include "sal/config.h"
+#endif
+#ifndef _SALHELPER_SIMPLEREFERENCEOBJECT_HXX_
+#include "salhelper/simplereferenceobject.hxx"
+#endif
+
+#ifndef _RTL_REF_HXX_
+#include "rtl/ref.hxx"
+#endif
+
+#if defined SOLAR_JAVA
+#include "jni.h"
+#else
+typedef void * jobject;
+#endif
+
+namespace jvmaccess {
+
+class VirtualMachine;
+
+/** An encapsulating wrapper around a Java virtual machine and an appropriate
+    UNO class loader.
+ */
+class UnoVirtualMachine: public salhelper::SimpleReferenceObject {
+public:
+    /** An exception indicating failure to create a UnoVirtualMachine.
+     */
+    class CreationException
+    {
+    public:
+        CreationException();
+
+        CreationException(CreationException const &);
+
+        virtual ~CreationException();
+
+        CreationException & operator =(CreationException const &);
+    };
+
+    /** Create a wrapper around a Java virtual machine and an appropriate UNO
+        class loader.
+
+        @param virtualMachine
+        A Java virtual machine wrapper.  Must not be null.
+
+        @param classLoader
+        A local or global JNI reference, relative to the given virtualMachine,
+        to an appropriate UNO class loader instance.  Must not be null.
+
+        @exception CreationException
+        Thrown in case creation fails (due to a JNI problem).
+     */
+    UnoVirtualMachine(
+        rtl::Reference< jvmaccess::VirtualMachine > const & virtualMachine,
+        jobject classLoader);
+
+    /** Get the Java virtual machine wrapper.
+
+        @return
+        The Java virtual machine wrapper.  Will never be null.
+     */
+    rtl::Reference< jvmaccess::VirtualMachine > getVirtualMachine() const;
+
+    /** Get the UNO class loader.
+
+        @return
+        A global JNI reference to the UNO class loader.  (The JNI reference must
+        not be deleted by client code.)  Will never be null.
+     */
+    jobject getClassLoader() const;
+
+private:
+    UnoVirtualMachine(UnoVirtualMachine &); // not defined
+    void operator =(UnoVirtualMachine &); // not defined
+
+    virtual ~UnoVirtualMachine();
+
+    rtl::Reference< jvmaccess::VirtualMachine > m_virtualMachine;
+    jobject m_classLoader;
+};
+
+}
+
+#endif