Mercurial > hg > orthanc-java
annotate Plugin/JavaEnvironment.cpp @ 41:d0b0bb6dfb4a
typo
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 03 Jul 2024 18:00:06 +0200 |
| parents | 10406d66d1c6 |
| children |
| rev | line source |
|---|---|
| 5 | 1 /** |
| 20 | 2 * SPDX-FileCopyrightText: 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
| 5 | 3 * SPDX-License-Identifier: GPL-3.0-or-later |
| 4 */ | |
| 5 | |
| 6 /** | |
| 7 * Java plugin for Orthanc | |
| 20 | 8 * Copyright (C) 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
| 5 | 9 * |
| 10 * This program is free software: you can redistribute it and/or | |
| 11 * modify it under the terms of the GNU General Public License as | |
| 12 * published by the Free Software Foundation, either version 3 of the | |
| 13 * License, or (at your option) any later version. | |
| 14 * | |
| 15 * This program is distributed in the hope that it will be useful, but | |
| 16 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 18 * General Public License for more details. | |
| 19 * | |
| 20 * You should have received a copy of the GNU General Public License | |
| 21 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 22 **/ | |
| 23 | |
| 24 | |
| 25 #include "JavaEnvironment.h" | |
|
27
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
26 #include "JavaString.h" |
| 5 | 27 |
| 28 #include <cassert> | |
| 29 #include <stdexcept> | |
| 30 | |
| 31 extern OrthancPluginContext* context_; | |
| 32 | |
| 33 | |
| 34 static const char* ORTHANC_EXCEPTION_JAVA_CLASS = "be/uclouvain/orthanc/OrthancException"; | |
| 35 | |
| 36 | |
| 37 JavaEnvironment::JavaEnvironment(JNIEnv* env) : | |
| 38 jvm_(NULL), | |
| 39 env_(env) | |
| 40 { | |
| 41 if (env_ == NULL) | |
| 42 { | |
| 43 throw std::runtime_error("Null pointer"); | |
| 44 } | |
| 45 } | |
| 46 | |
| 47 | |
| 48 JavaEnvironment::JavaEnvironment(JavaVirtualMachine& jvm) : | |
| 49 jvm_(&jvm.GetValue()) | |
| 50 { | |
| 51 jint status = jvm_->GetEnv((void **) &env_, JNI_VERSION_1_6); | |
| 52 | |
| 53 switch (status) | |
| 54 { | |
| 55 case JNI_OK: | |
| 56 break; | |
| 57 | |
| 58 case JNI_EDETACHED: | |
| 59 { | |
| 60 jint code = jvm_->AttachCurrentThread((void **) &env_, NULL); | |
| 61 if (code != JNI_OK) | |
| 62 { | |
| 63 throw std::runtime_error("Cannot attach thread"); | |
| 64 } | |
| 65 break; | |
| 66 } | |
| 67 | |
| 68 case JNI_EVERSION: | |
| 69 throw std::runtime_error("JNI version not supported"); | |
| 70 | |
| 71 default: | |
| 72 throw std::runtime_error("Not implemented"); | |
| 73 } | |
| 74 | |
| 75 if (env_ == NULL) | |
| 76 { | |
| 77 throw std::runtime_error("Error inside JNI"); | |
| 78 } | |
| 79 } | |
| 80 | |
| 81 | |
| 82 JavaEnvironment::~JavaEnvironment() | |
| 83 { | |
| 84 if (jvm_ != NULL) | |
| 85 { | |
| 86 jvm_->DetachCurrentThread(); | |
| 87 } | |
| 88 } | |
| 89 | |
| 90 | |
| 91 JNIEnv& JavaEnvironment::GetValue() | |
| 92 { | |
| 93 assert(env_ != NULL); | |
| 94 return *env_; | |
| 95 } | |
| 96 | |
| 97 | |
| 98 void JavaEnvironment::CheckException() | |
| 99 { | |
| 100 if (env_->ExceptionCheck() == JNI_TRUE) | |
| 101 { | |
|
27
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
102 jthrowable e = env_->ExceptionOccurred(); |
| 5 | 103 env_->ExceptionClear(); |
|
27
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
104 |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
105 jclass clazz = env_->GetObjectClass(e); |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
106 if (clazz != NULL) |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
107 { |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
108 jmethodID getMessage = env_->GetMethodID(clazz, "getMessage", "()Ljava/lang/String;"); |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
109 if (getMessage != NULL) |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
110 { |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
111 JavaString message(env_, (jstring) env_->CallObjectMethod(e, getMessage)); |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
112 throw std::runtime_error("An exception has occurred in Java: " + std::string(message.GetValue())); |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
113 } |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
114 } |
|
4a750ca9461e
logging message associated with an exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
115 |
| 5 | 116 throw std::runtime_error("An exception has occurred in Java"); |
| 117 } | |
| 118 } | |
| 119 | |
| 120 | |
| 121 void JavaEnvironment::ThrowException(const std::string& fqn, | |
| 122 const std::string& message) | |
| 123 { | |
| 124 if (GetValue().ThrowNew(FindClass(fqn), message.c_str()) != 0) | |
| 125 { | |
| 33 | 126 std::string tmp = "Cannot throw exception " + fqn; |
| 127 OrthancPluginLogError(context_, tmp.c_str()); | |
| 5 | 128 } |
| 129 } | |
| 130 | |
| 131 | |
| 132 void JavaEnvironment::ThrowOrthancException(const std::string& message) | |
| 133 { | |
| 134 ThrowException(ORTHANC_EXCEPTION_JAVA_CLASS, message); | |
| 135 } | |
| 136 | |
| 137 | |
| 138 void JavaEnvironment::ThrowOrthancException(OrthancPluginErrorCode code) | |
| 139 { | |
| 140 ThrowException(ORTHANC_EXCEPTION_JAVA_CLASS, OrthancPluginGetErrorDescription(context_, code)); | |
| 141 } | |
| 142 | |
| 143 | |
| 144 void JavaEnvironment::ThrowOrthancException(JNIEnv* env, | |
| 145 const std::string& message) | |
| 146 { | |
| 147 JavaEnvironment e(env); | |
| 148 e.ThrowOrthancException(message); | |
| 149 } | |
| 150 | |
| 151 | |
| 152 void JavaEnvironment::ThrowOrthancException(JNIEnv* env, | |
| 153 OrthancPluginErrorCode code) | |
| 154 { | |
| 155 JavaEnvironment e(env); | |
| 156 e.ThrowOrthancException(code); | |
| 157 } | |
| 158 | |
| 159 | |
| 160 void JavaEnvironment::RegisterNatives(const std::string& fqn, | |
| 161 const std::vector<JNINativeMethod>& methods) | |
| 162 { | |
| 163 if (!methods.empty()) | |
| 164 { | |
| 165 if (env_->RegisterNatives(FindClass(fqn), &methods[0], methods.size()) < 0) | |
| 166 { | |
| 167 throw std::runtime_error("Unable to register the native methods"); | |
| 168 } | |
| 169 } | |
| 170 } | |
| 171 | |
| 172 | |
| 173 void JavaEnvironment::RunGarbageCollector() | |
| 174 { | |
| 175 assert(env_ != NULL); | |
| 176 | |
| 177 jclass system = FindClass("java/lang/System"); | |
| 178 | |
| 179 jmethodID runFinalization = env_->GetStaticMethodID(system, "gc", "()V"); | |
| 180 if (runFinalization != NULL) | |
| 181 { | |
| 182 env_->CallStaticVoidMethod(system, runFinalization); | |
| 183 CheckException(); | |
| 184 } | |
| 185 else | |
| 186 { | |
| 187 throw std::runtime_error("Cannot run garbage collector"); | |
| 188 } | |
| 189 } | |
| 190 | |
| 191 | |
| 192 jclass JavaEnvironment::FindClass(const std::string& fqn) | |
| 193 { | |
| 194 jclass c = GetValue().FindClass(fqn.c_str()); | |
| 195 | |
| 196 if (c == NULL) | |
| 197 { | |
| 198 throw std::runtime_error("Unable to find class: " + fqn); | |
| 199 } | |
| 200 else | |
| 201 { | |
| 202 return c; | |
| 203 } | |
| 204 } | |
| 205 | |
| 206 | |
| 207 jclass JavaEnvironment::GetObjectClass(jobject obj) | |
| 208 { | |
| 209 jclass c = GetValue().GetObjectClass(obj); | |
| 210 | |
| 211 if (c == NULL) | |
| 212 { | |
| 213 throw std::runtime_error("Unable to get class of object"); | |
| 214 } | |
| 215 else | |
| 216 { | |
| 217 return c; | |
| 218 } | |
| 219 } | |
| 220 | |
| 221 | |
| 222 jmethodID JavaEnvironment::GetMethodID(jclass c, | |
| 223 const std::string& method, | |
| 224 const std::string& signature) | |
| 225 { | |
| 226 jmethodID m = GetValue().GetMethodID(c, method.c_str(), signature.c_str()); | |
| 227 | |
| 228 if (m == NULL) | |
| 229 { | |
| 230 throw std::runtime_error("Unable to locate method in class"); | |
| 231 } | |
| 232 else | |
| 233 { | |
| 234 return m; | |
| 235 } | |
| 236 } | |
| 237 | |
| 238 | |
| 239 jobject JavaEnvironment::ConstructJavaWrapper(const std::string& fqn, | |
| 240 void* nativeObject) | |
| 241 { | |
| 242 jclass cls = FindClass(fqn); | |
| 243 jmethodID constructor = GetMethodID(cls, "<init>", "(J)V"); | |
| 244 jobject obj = env_->NewObject(cls, constructor, reinterpret_cast<intptr_t>(nativeObject)); | |
| 245 | |
| 246 if (obj == NULL) | |
| 247 { | |
| 248 throw std::runtime_error("Cannot create Java wrapper around C/C++ object: " + fqn); | |
| 249 } | |
| 250 else | |
| 251 { | |
| 252 return obj; | |
| 253 } | |
| 254 } | |
| 255 | |
| 256 | |
| 257 jbyteArray JavaEnvironment::ConstructByteArray(const size_t size, | |
| 258 const void* data) | |
| 259 { | |
| 260 assert(env_ != NULL); | |
| 261 jbyteArray obj = env_->NewByteArray(size); | |
| 262 if (obj == NULL) | |
| 263 { | |
| 264 throw std::runtime_error("Cannot create a byte array"); | |
| 265 } | |
| 266 else | |
| 267 { | |
| 268 if (size > 0) | |
| 269 { | |
| 270 env_->SetByteArrayRegion(obj, 0, size, reinterpret_cast<const jbyte*>(data)); | |
| 271 } | |
| 272 | |
| 273 return obj; | |
| 274 } | |
| 275 } | |
| 276 | |
| 277 | |
| 278 jobject JavaEnvironment::ConstructEnumValue(const std::string& fqn, | |
| 279 int value) | |
| 280 { | |
| 281 assert(env_ != NULL); | |
| 282 jclass cls = FindClass(fqn); | |
| 283 | |
| 284 std::string signature = "(I)L" + fqn + ";"; | |
| 285 jmethodID constructor = env_->GetStaticMethodID(cls, "getInstance", signature.c_str()); | |
| 286 if (constructor != NULL) | |
| 287 { | |
| 288 jobject obj = env_->CallStaticObjectMethod(cls, constructor, static_cast<jint>(value)); | |
| 289 CheckException(); | |
| 290 return obj; | |
| 291 } | |
| 292 else | |
| 293 { | |
| 294 char buf[16]; | |
| 295 sprintf(buf, "%d", value); | |
| 296 throw std::runtime_error("Cannot create enumeration value: " + fqn + " " + buf); | |
| 297 } | |
| 298 } |