| /************************************************************** | |
| * | |
| * Licensed to the Apache Software Foundation (ASF) under one | |
| * or more contributor license agreements. See the NOTICE file | |
| * distributed with this work for additional information | |
| * regarding copyright ownership. The ASF licenses this file | |
| * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 | |
| * | |
| * Unless required by applicable law or agreed to in writing, | |
| * software distributed under the License is distributed on an | |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| * KIND, either express or implied. See the License for the | |
| * specific language governing permissions and limitations | |
| * under the License. | |
| * | |
| *************************************************************/ | |
| #ifndef __com_sun_star_java_XJavaVM_idl__ | |
| #define __com_sun_star_java_XJavaVM_idl__ | |
| #ifndef __com_sun_star_uno_XInterface_idl__ | |
| #include <com/sun/star/uno/XInterface.idl> | |
| #endif | |
| //============================================================================= | |
| module com { module sun { module star { module java { | |
| //============================================================================= | |
| // DocMerge from xml: interface com::sun::star::java::XJavaVM | |
| /** must be implemented by the user of the XJavaVM. | |
| @deprecated | |
| A UNO interface seems to be at the wrong abstraction level for this | |
| functionality (also, the C++ classes <code>jvmaccess::VirtualMachine</code> | |
| and <code>jvmaccess::UnoVirtualMachine</code> used by | |
| <member scope="com::sun::star::java">XJavaVM::getJavaVM</member> are not | |
| part of the public C++ UNO runtime API). This should probably be replaced | |
| by an appropriate C/C++ API. | |
| */ | |
| published interface XJavaVM: com::sun::star::uno::XInterface | |
| { | |
| //------------------------------------------------------------------------- | |
| // DocMerge from xml: method com::sun::star::java::XJavaVM::getJavaVM | |
| /** returns the address of the Java Virtual Machine. | |
| <p>If the VM is not already instantiated, it will be now.</p> | |
| <p>If the <code>processID</code> is a normal 16-byte ID, the returned | |
| <atom>any</atom> contains a JNI <code>JavaVM</code> pointer as a | |
| <atom>long</atom> or <atom>hyper</atom> integer (depending on the | |
| platform). If the <code>processID</code> does not match the current | |
| process, or if the VM cannot be instantiated for whatever reason, a | |
| <void/> <atom>any</atom> is returned.</p> | |
| <p>If the <code>processID</code> has an additional 17th byte of | |
| value <code>0</code>, the returned <atom>any</atom> contains a | |
| non–reference-counted pointer to a (reference-counted) instance of | |
| the C++ <code>jvmaccess::VirtualMachine</code> class, always represented | |
| as a <atom>hyper</atom> integer. The pointer is guaranteed to be valid | |
| as long as the reference to this | |
| <type scope="com::sun::star::java">XJavaVM</type> is valid (but the | |
| pointer should be converted into a reference-counted reference as soon | |
| as possible). Again, if the first 16 bytes of the | |
| <code>processID</code> do not match the current process, or if the VM | |
| cannot be instantiated for whatever reason, a <void/> <atom>any</atom> | |
| is returned.</p> | |
| <p>If the <code>processID</code> has an additional 17th byte of | |
| value <code>1</code>, the returned <atom>any</atom> contains a | |
| non–reference-counted pointer to a (reference-counted) instance of | |
| the C++ <code>jvmaccess::UnoVirtualMachine</code> class, always | |
| represented as a <atom>hyper</atom> integer. The pointer is guaranteed | |
| to be valid as long as the reference to this | |
| <type scope="com::sun::star::java">XJavaVM</type> is valid. Again, if | |
| the first 16 bytes of the <code>processID</code> do not match the | |
| current process, or if the VM cannot be instantiated for whatever | |
| reason, a <void/> <atom>any</atom> is returned.</p> | |
| <p>The first form (returning a JNI <code>JavaVM</code> pointer) is | |
| mainly for backwards compatibility, new code should use the second form | |
| (returning a pointer to a <code>jvmaccess::VirtualMachine</code>) if it | |
| does not want to use the Java UNO environment, and it should use the | |
| third form (returning a pointer to a | |
| <code>jvmaccess::UnoVirtualMachine</code>) if it wants to use the Java | |
| UNO environment. For example, one advantage of using | |
| <code>jvmaccess::VirtualMachine</code> instead of the raw | |
| <code>JavaVM</code> pointer is that whenever you attach a native thread | |
| to the Java virtual machine, that thread's context | |
| <code>ClassLoader</code> (see | |
| <code>java.lang.Thread.getContextClassLoader</code>) will automatically | |
| be set to a meaningful value.</p> | |
| @param processID | |
| The process ID of the caller's process, possibly extended by a 17th byte | |
| of value <code>0</code> or <code>1</code>. | |
| @return | |
| On success, the <atom>any</atom> contains a pointer represented as | |
| <atom>long</atom> or <atom>hyper</atom>, otherwise the <atom>any</atom> | |
| is <void/>. | |
| */ | |
| any getJavaVM( [in] sequence<byte> processID ); | |
| //------------------------------------------------------------------------- | |
| // DocMerge from xml: method com::sun::star::java::XJavaVM::isVMStarted | |
| /** returns <true/> if the VM is started successfully, otherwise <false/>. | |
| */ | |
| boolean isVMStarted(); | |
| //------------------------------------------------------------------------- | |
| // DocMerge from xml: method com::sun::star::java::XJavaVM::isVMEnabled | |
| /** Returns <true/> if the VM is enabled. | |
| <p>It is only possible to get the VM, if this method return 0. </p> | |
| */ | |
| boolean isVMEnabled(); | |
| }; | |
| //============================================================================= | |
| }; }; }; }; | |
| /*============================================================================= | |
| =============================================================================*/ | |
| #endif |