1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef __com_sun_star_java_XJavaVM_idl__
#define __com_sun_star_java_XJavaVM_idl__
#include <com/sun/star/uno/XInterface.idl>
//=============================================================================
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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
