Mercurial > hg > orthanc-java
annotate JavaSDK/be/uclouvain/orthanc/Peers.java @ 18:15dc698243ac
update year to 2024
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 05 Jan 2024 16:32:33 +0100 |
| parents | 26c08ff926a3 |
| children |
| rev | line source |
|---|---|
| 0 | 1 package be.uclouvain.orthanc; |
| 2 | |
| 3 /** | |
| 18 | 4 * SPDX-FileCopyrightText: 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
| 0 | 5 * SPDX-License-Identifier: GPL-3.0-or-later |
| 6 */ | |
| 7 | |
| 8 /** | |
| 9 * Java plugin for Orthanc | |
| 18 | 10 * Copyright (C) 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
| 0 | 11 * |
| 12 * This program is free software: you can redistribute it and/or | |
| 13 * modify it under the terms of the GNU General Public License as | |
| 14 * published by the Free Software Foundation, either version 3 of the | |
| 15 * License, or (at your option) any later version. | |
| 16 * | |
| 17 * This program is distributed in the hope that it will be useful, but | |
| 18 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 20 * General Public License for more details. | |
| 21 * | |
| 22 * You should have received a copy of the GNU General Public License | |
| 23 * along with this program. If not, see http://www.gnu.org/licenses/. | |
| 24 **/ | |
| 25 | |
| 26 | |
|
8
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
27 // WARNING: Auto-generated file. Do not modify it by hand. |
|
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
28 |
| 0 | 29 /** |
| 30 * Orthanc peer | |
| 31 **/ | |
| 32 public class Peers { | |
| 33 private long self; | |
| 34 | |
| 35 /** | |
| 36 * Construct a Java object wrapping a C object that is managed by Orthanc. | |
| 37 * @param self Pointer to the C object. | |
| 38 **/ | |
| 39 protected Peers(long self) { | |
| 40 if (self == 0) { | |
| 41 throw new IllegalArgumentException("Null pointer"); | |
| 42 } else { | |
| 43 this.self = self; | |
| 44 } | |
| 45 } | |
| 46 | |
| 47 /** | |
| 48 * Return the C object that is associated with this Java wrapper. | |
| 49 * @return Pointer to the C object. | |
| 50 **/ | |
| 51 protected long getSelf() { | |
| 52 return self; | |
| 53 } | |
| 54 | |
| 55 @Override | |
| 56 protected void finalize() throws Throwable { | |
| 57 dispose(); | |
| 58 super.finalize(); | |
| 59 } | |
| 60 | |
| 61 /** | |
| 62 * Manually deallocate the C object that is associated with this Java wrapper. | |
| 63 * | |
| 64 * This method can be used to immediately deallocate the C object, | |
| 65 * instead of waiting for the garbage collector to dispose the Java wrapper. | |
| 66 **/ | |
| 67 public void dispose() { | |
| 68 if (self != 0) { | |
| 69 NativeSDK.OrthancPluginFreePeers(self); | |
| 70 self = 0; | |
| 71 } | |
| 72 } | |
| 73 | |
| 74 /** | |
| 75 * Return the list of available Orthanc peers. | |
| 76 * | |
| 77 * This function returns the parameters of the Orthanc peers that are known to the | |
| 78 * Orthanc server hosting the plugin. | |
| 79 * | |
| 80 * @return The newly constructed object. | |
| 81 **/ | |
| 82 public static Peers getPeers() { | |
| 83 return new Peers(NativeSDK.OrthancPluginGetPeers()); | |
| 84 } | |
| 85 | |
| 86 | |
| 87 /** | |
| 88 * Get the number of Orthanc peers. | |
| 89 * | |
| 90 * This function returns the number of Orthanc peers. | |
| 91 * | |
| 92 * This function is thread-safe: Several threads sharing the same | |
| 93 * OrthancPluginPeers object can simultaneously call this function. | |
| 94 * | |
| 95 * @return The number of peers. | |
| 96 **/ | |
| 97 public int getPeersCount() { | |
| 98 return NativeSDK.OrthancPluginGetPeersCount(self); | |
| 99 } | |
| 100 | |
| 101 /** | |
| 102 * Get the symbolic name of an Orthanc peer. | |
| 103 * | |
| 104 * This function returns the symbolic name of the Orthanc peer, which corresponds | |
| 105 * to the key of the "OrthancPeers" configuration option of Orthanc. | |
| 106 * | |
| 107 * This function is thread-safe: Several threads sharing the same | |
| 108 * OrthancPluginPeers object can simultaneously call this function. | |
| 109 * | |
| 110 * @param peerIndex The index of the peer of interest. This value must be lower | |
| 111 * than OrthancPluginGetPeersCount(). | |
| 112 * @return The resulting string. | |
| 113 **/ | |
| 114 public String getPeerName( | |
| 115 int peerIndex) { | |
| 116 return NativeSDK.OrthancPluginGetPeerName(self, peerIndex); | |
| 117 } | |
| 118 | |
| 119 /** | |
| 120 * Get the base URL of an Orthanc peer. | |
| 121 * | |
| 122 * This function returns the base URL to the REST API of some Orthanc peer. | |
| 123 * | |
| 124 * This function is thread-safe: Several threads sharing the same | |
| 125 * OrthancPluginPeers object can simultaneously call this function. | |
| 126 * | |
| 127 * @param peerIndex The index of the peer of interest. This value must be lower | |
| 128 * than OrthancPluginGetPeersCount(). | |
| 129 * @return The resulting string. | |
| 130 **/ | |
| 131 public String getPeerUrl( | |
| 132 int peerIndex) { | |
| 133 return NativeSDK.OrthancPluginGetPeerUrl(self, peerIndex); | |
| 134 } | |
| 135 | |
| 136 /** | |
| 137 * Get some user-defined property of an Orthanc peer. | |
| 138 * | |
| 139 * This function returns some user-defined property of some Orthanc peer. An | |
| 140 * user-defined property is a property that is associated with the peer in the | |
| 141 * Orthanc configuration file, but that is not recognized by the Orthanc core. | |
| 142 * | |
| 143 * This function is thread-safe: Several threads sharing the same | |
| 144 * OrthancPluginPeers object can simultaneously call this function. | |
| 145 * | |
| 146 * @param peerIndex The index of the peer of interest. This value must be lower | |
| 147 * than OrthancPluginGetPeersCount(). | |
| 148 * @param userProperty The user property of interest. | |
| 149 * @return The resulting string. | |
| 150 **/ | |
| 151 public String getPeerUserProperty( | |
| 152 int peerIndex, | |
| 153 String userProperty) { | |
| 154 return NativeSDK.OrthancPluginGetPeerUserProperty(self, peerIndex, userProperty); | |
| 155 } | |
| 156 | |
| 157 } |