Spec-Zone.ru › OpenJDK 21

Класс JMXServiceURL

java.lang.Object
javax.management.remote.JMXServiceURL
Все реализованные интерфейсы:
Serializable
public class JMXServiceURL extends Object implements Serializable

Адрес сервера-коннектора API JMX. Экземпляры этого класса неизменяемы.

Адрес представляет собой абстрактный URL-адрес сервиса для SLP, как определено в RFC 2609 и дополнено RFC 3111. Он должен выглядеть так:

service:jmx:protocol:sap

Здесь, protocol — это транспортный протокол, который будет использоваться для подключения к серверу коннектора. Это строка из одного или нескольких ASCII-символов, каждый из которых является буквой, цифрой или одним из символов + или -. Первый символ должен быть буквой. Прописные буквы преобразуются в строчные.

sap — это адрес, по которому находится сервер коннектора. Этот адрес использует подмножество синтаксиса, определенного в RFC 2609 для протоколов, основанных на IP. Это подмножество, поскольку синтаксис user@host не поддерживается.

Другие синтаксисы, определенные в RFC 2609, в настоящее время не поддерживаются этим классом.

Поддерживаемый синтаксис:

//[host[:port]][url-path]

Квадратные скобки [] указывают на необязательные части адреса. Не все протоколы распознают все необязательные части.

host — это имя хоста, числовой адрес хоста IPv4 или числовой адрес IPv6 в квадратных скобках.

port — это десятичное число порта. 0 означает порт по умолчанию или анонимный порт, в зависимости от протокола.

host и port могут быть опущены. port нельзя указать без host.

url-path, если есть, начинается с косой черты (/) или с точки с запятой (;) и продолжается до конца адреса. Он может содержать атрибуты, используя синтаксис точки с запятой, указанный в RFC 2609. Эти атрибуты не анализируются этим классом, и неверный синтаксис атрибутов не обнаруживается.

Хотя в соответствии с RFC 2609 разрешено иметь url-path, начинающийся с точки с запятой, не все реализации SLP это позволяют, поэтому рекомендуется избегать этого синтаксиса.

Регистр не важен в исходной строке service:jmx:protocol или в части хоста адреса. В зависимости от протокола, регистр может быть существенным в url-path.

С тех пор:
1.5
См. также:
  • RFC 2609, "Шаблоны служб и Service: схемы"
  • RFC 3111, "Изменения протокола обнаружения служб для IPv6"
  • Сериализованная форма

Краткое описание конструкторов

Конструктор Описание
JMXServiceURL(String serviceURL)
Создает JMXServiceURL, анализируя строку URL-адреса службы.
JMXServiceURL(String protocol, String host, int port)
Создаёт JMXServiceURL с заданным протоколом, хостом и портом.
JMXServiceURL(String protocol, String host, int port, String urlPath)
Создает JMXServiceURL с заданными частями.

Краткое описание методов

Модификатор и тип Метод Описание
boolean equals(Object obj)
Указывает, равен ли какой-либо другой объект данному.
String getHost()
Часть хоста URL-адреса службы.
int getPort()
Порт URL-адреса службы.
String getProtocol()
Часть протокола URL-адреса службы.
String getURLPath()
Часть пути URL-адреса службы.
String toString()
Строковое представление этого URL-адреса службы.

Методы, объявленные в классе java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

JMXServiceURL

public JMXServiceURL(String serviceURL) throws MalformedURLException

Создаёт JMXServiceURL путём парсинга строки URL службы.

Параметры:
serviceURL - строка URL, подлежащая парсингу.
Исключения:
NullPointerException - если serviceURL равно null.
MalformedURLException - если serviceURL не соответствует синтаксису абстрактного URL службы или не является допустимым именем службы JMX удалённого API. JMXServiceURL должен начинаться со строки "service:jmx:" (регистр не учитывается). Он не должен содержать символов, не являющихся печатными символами ASCII.

JMXServiceURL

public JMXServiceURL(String protocol, String host, int port) throws MalformedURLException

Создаёт JMXServiceURL с заданным протоколом, хостом и портом. Этот конструктор эквивалентен JMXServiceURL(protocol, host, port, null).

Параметры:
protocol - часть протокола URL. Если null, по умолчанию jmxmp.
host - часть хоста URL. Если host равен null и имя хоста локальной машины может быть разрешено в IP-адрес, тогда host по умолчанию — имя хоста локальной машины, определяемое по InetAddress.getLocalHost().getHostName(). Если host равен null и имя хоста локальной машины не может быть разрешено в IP-адрес, то host по умолчанию — числовой IP-адрес одного из активных сетевых интерфейсов. Если host — числовой IPv6-адрес, он может быть необязательно заключён в квадратные скобки [].
port - часть порта URL.
Исключения:
MalformedURLException - если одна из частей синтаксически некорректна, или если host равно null, и невозможно найти имя хоста локальной машины, или если port отрицательно.

JMXServiceURL

public JMXServiceURL(String protocol, String host, int port, String urlPath) throws MalformedURLException

Создаёт JMXServiceURL с указанными частями.

Параметры:
protocol - часть протокола URL. Если null, по умолчанию jmxmp.
host - часть хоста URL. Если host равен null и имя хоста локальной машины может быть разрешено в IP-адрес, тогда host по умолчанию — имя хоста локальной машины, определяемое по InetAddress.getLocalHost().getHostName(). Если host равен null и имя хоста локальной машины не может быть разрешено в IP-адрес, то host по умолчанию — числовой IP-адрес одного из активных сетевых интерфейсов. Если host — числовой IPv6-адрес, он может быть необязательно заключён в квадратные скобки [].
port - часть порта URL.
urlPath - часть пути URL. Если null, по умолчанию — пустая строка.
Исключения:
MalformedURLException - если одна из частей синтаксически некорректна, или если host равно null, и невозможно найти имя хоста локальной машины, или если port отрицательно.

Подробное описание методов

getProtocol

public String getProtocol()

Часть протокола URL службы.

Возвращает:
часть протокола URL службы. Никогда не null.

getHost

public String getHost()

Часть хоста URL службы. Если URL службы был создан с конструктором, принимающим строку URL в качестве параметра, результат — подстрока, определяющая хост в этом URL. Если URL службы был создан с конструктором, принимающим отдельный параметр хоста, результат — указанная строка. Если эта строка была равна null, результат — InetAddress.getLocalHost().getHostName() если имя хоста локальной машины может быть разрешено в IP-адрес. В противном случае будет использован числовой IP-адрес активного сетевого интерфейса.

В любом случае, если хост был указан с использованием синтаксиса [...] для числовых IPv6-адресов, квадратные скобки в возвращаемом значении здесь не включаются.

Возвращает:
часть хоста URL службы. Никогда не null.

getPort

public int getPort()

Порт URL службы. Если порт не был указан, возвращаемое значение — 0.

Возвращает:
порт URL службы, или 0, если нет.

getURLPath

public String getURLPath()

Часть пути URL службы. Это пустая строка или строка, начинающаяся с косой черты (/), или строка, начинающаяся с точки с запятой (;).

Возвращает:
часть пути URL службы. Никогда не null.

toString

public String toString()

Строковое представление этого URL службы. Если возвращаемое значение этого метода передаётся в конструктор JMXServiceURL, полученный объект будет равен этому.

Часть host возвращаемой строки — значение, возвращаемое getHost(). Если это значение определяет числовой IPv6-адрес, оно окружено квадратными скобками [].

Часть port возвращаемой строки — значение, возвращаемое getPort() в его кратчайшей десятичной форме. Если значение равно нулю, оно опущено.

Overrides:
toString в классе Object
Возвращает:
строковое представление этого URL службы.

equals

public boolean equals(Object obj)

Указывает, равен ли некоторый другой объект этому. Этот метод возвращает true тогда и только тогда, когда obj является экземпляром JMXServiceURL, чьи методы getProtocol(), getHost(), getPort() и getURLPath() возвращают те же значения, что и для этого объекта. Значения для getProtocol() и getHost() могут отличаться регистром без влияния на равенство.

Overrides:
equals в классе Object
Параметры:
obj - ссылка на сравниваемый объект.
Возвращает:
true если этот объект такой же, как и obj аргумент; false в противном случае.
См. также:
  • Object.hashCode()
  • HashMap

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/remote/JMXServiceURL.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API