udkapi/com/sun/star/java/XJavaVM.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module java {
  22
  23 /** must be implemented by the user of the XJavaVM.
  24
  25     @deprecated
  26     A UNO interface seems to be at the wrong abstraction level for this
  27     functionality (also, the C++ classes <code>jvmaccess::VirtualMachine</code>
  28     and <code>jvmaccess::UnoVirtualMachine</code> used by
  29     com::sun::star::java::XJavaVM::getJavaVM() are not
  30     part of the public C++ UNO runtime API).  This should probably be replaced
  31     by an appropriate C/C++ API.
  32  */
  33 published interface XJavaVM: com::sun::star::uno::XInterface
  34 {
  35     /** returns the address of the Java Virtual Machine.
  36
  37         <p>If the VM is not already instantiated, it will be now.</p>
  38
  39         <p>If the <code>processID</code> is a normal 16-byte ID, the returned
  40         `any` contains a JNI <code>JavaVM</code> pointer as a
  41         `long` or `hyper` integer (depending on the
  42         platform).  If the <code>processID</code> does not match the current
  43         process, or if the VM cannot be instantiated for whatever reason, a
  44         `VOID` `any` is returned.</p>
  45
  46         <p>If the <code>processID</code> has an additional 17th byte of
  47         value&nbsp;<code>0</code>, the returned `any` contains a
  48         non&ndash;reference-counted pointer to a (reference-counted) instance of
  49         the C++ <code>jvmaccess::VirtualMachine</code> class, always represented
  50         as a `hyper` integer.  The pointer is guaranteed to be valid
  51         as long as the reference to this
  52         com::sun::star::java::XJavaVM is valid (but the
  53         pointer should be converted into a reference-counted reference as soon
  54         as possible).  Again, if the first 16 bytes of the
  55         <code>processID</code> do not match the current process, or if the VM
  56         cannot be instantiated for whatever reason, a `VOID` `any`
  57         is returned.</p>
  58
  59         <p>If the <code>processID</code> has an additional 17th byte of
  60         value&nbsp;<code>1</code>, the returned `any` contains a
  61         non&ndash;reference-counted pointer to a (reference-counted) instance of
  62         the C++ <code>jvmaccess::UnoVirtualMachine</code> class, always
  63         represented as a `hyper` integer.  The pointer is guaranteed
  64         to be valid as long as the reference to this
  65         com::sun::star::java::XJavaVM is valid.  Again, if
  66         the first 16 bytes of the <code>processID</code> do not match the
  67         current process, or if the VM cannot be instantiated for whatever
  68         reason, a `VOID` `any` is returned.</p>
  69
  70         <p>The first form (returning a JNI <code>JavaVM</code> pointer) is
  71         mainly for backwards compatibility, new code should use the second form
  72         (returning a pointer to a <code>jvmaccess::VirtualMachine</code>) if it
  73         does not want to use the Java UNO environment, and it should use the
  74         third form (returning a pointer to a
  75         <code>jvmaccess::UnoVirtualMachine</code>) if it wants to use the Java
  76         UNO environment.  For example, one advantage of using
  77         <code>jvmaccess::VirtualMachine</code> instead of the raw
  78         <code>JavaVM</code> pointer is that whenever you attach a native thread
  79         to the Java virtual machine, that thread's context
  80         <code>ClassLoader</code> (see
  81         <code>java.lang.Thread.getContextClassLoader</code>) will automatically
  82         be set to a meaningful value.</p>
  83
  84         @param processID
  85         The process ID of the caller's process, possibly extended by a 17th byte
  86         of value <code>0</code> or&nbsp;<code>1</code>.
  87
  88         @return
  89         On success, the `any` contains a pointer represented as
  90         `long` or `hyper`, otherwise the `any`
  91         is `VOID`.
  92      */
  93     any getJavaVM( [in] sequence<byte> processID );
  94
  95     /** returns `TRUE` if the VM is started successfully, otherwise `FALSE`.
  96      */
  97     boolean isVMStarted();
  98
  99     /** Returns `TRUE` if the VM is enabled.
 100
 101         <p>It is only possible to get the VM, if this method return 0. </p>
 102      */
 103     boolean isVMEnabled();
 104
 105 };
 106
 107
 108 }; }; }; };
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */