Spec-Zone.ru › OpenJDK 25

Класс RMIConnector

java.lang.Object
javax.management.remote.rmi.RMIConnector
Все реализуемые интерфейсы:
Closeable, Serializable, AutoCloseable, JMXAddressable, JMXConnector
public class RMIConnector extends Object implements JMXConnector, Serializable, JMXAddressable

Подключение к удалённому коннектору RMI. Обычно такие подключения устанавливаются с помощью JMXConnectorFactory. Однако специализированные приложения могут использовать этот класс напрямую, например с заглушкой RMIServer, полученной без обращения к JNDI.

Начиная с:
1.5
См. также:
  • Сериализованная форма

Краткое описание полей

Поля, объявленные в интерфейсе JMXConnector

CREDENTIALS

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

Конструктор Описание
RMIConnector(JMXServiceURL url, Map<String,?> environment)
Создаёт RMIConnector, который подключается к серверу коннектора RMI по указанному адресу.
RMIConnector(RMIServer rmiServer, Map<String,?> environment)
Создаёт RMIConnector с помощью указанной заглушки RMI.

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

Модификатор и тип Метод Описание
void addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
Добавляет слушателя для получения уведомлений об изменениях состояния подключения.
void close()
Закрывает клиентское подключение к серверу.
void connect()
Устанавливает подключение к серверу коннектора.
void connect(Map<String,?> environment)
Устанавливает подключение к серверу коннектора.
JMXServiceURL getAddress()
Адрес этого коннектора.
String getConnectionId()
Получает идентификатор этого подключения от сервера коннектора.
MBeanServerConnection getMBeanServerConnection()
Возвращает объект MBeanServerConnection, представляющий удалённый сервер MBean.
void removeConnectionNotificationListener(NotificationListener listener)
Удаляет слушателя из списка получающих уведомления об изменениях состояния.
void removeConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
Удаляет слушателя из списка получающих уведомления об изменениях состояния.
String toString()
Возвращает строковое представление этого объекта.

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

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

Методы, объявленные в интерфейсе JMXConnector

getMBeanServerConnection

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

RMIConnector

public RMIConnector(JMXServiceURL url, Map<String,?> environment)

Создаёт RMIConnector, который подключается к серверу коннектора RMI по указанному адресу.

Адрес может непосредственно указывать на сервер коннектора и иметь следующий синтаксис:

service:jmx:rmi://[host[:port]]/stub/encoded-stub

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

Вместо этого адрес может указывать, где найти заглушку RMI через JNDI, и иметь следующий синтаксис:

service:jmx:rmi://[host[:port]]/jndi/jndi-name

Реализация также может распознавать дополнительные форматы адресов, например:

service:jmx:myprotocolname://[host[:port]]/stub/encoded-stub
Параметры:
url — адрес сервера коннектора RMI.
environment — дополнительные атрибуты, задающие способ установления подключения. Для адресов на основе JNDI к этим атрибутам могут относиться атрибуты JNDI, распознаваемые InitialContext. Параметр может иметь значение null, что эквивалентно пустой карте.
Вызывает:
IllegalArgumentException — если url имеет значение null.

RMIConnector

public RMIConnector(RMIServer rmiServer, Map<String,?> environment)

Создаёт RMIConnector с помощью указанной заглушки RMI.

Параметры:
rmiServer — заглушка RMI, представляющая сервер коннектора RMI.
environment — дополнительные атрибуты, задающие способ установления подключения. Параметр может иметь значение null, что эквивалентно пустой карте.
Вызывает:
IllegalArgumentException — если rmiServer имеет значение null.

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

toString

public String toString()

Возвращает строковое представление этого объекта. В общем случае метод toString возвращает строку, которая «текстуально представляет» этот объект. Результат должен быть кратким, но информативным и удобным для чтения.

Переопределяет:
toString в классе Object
Возвращает:
строковое представление этого объекта.

getAddress

public JMXServiceURL getAddress()

Адрес этого коннектора.

Определён в:
getAddress в интерфейсе JMXAddressable
Возвращает:
адрес этого коннектора или null, если адрес отсутствует.
Начиная с:
1.6

connect

public void connect() throws IOException
Описание скопировано из интерфейса: JMXConnector

Устанавливает подключение к серверу коннектора. Этот метод эквивалентен методу connect(null).

Определён в:
connect в интерфейсе JMXConnector
Вызывает:
IOException — если подключение не удалось установить из-за проблем со связью

connect

public void connect(Map<String,?> environment) throws IOException
Описание скопировано из интерфейса: JMXConnector

Устанавливает подключение к серверу коннектора.

Если для этого объекта уже был успешно вызван метод connect, повторный вызов не повлияет на его состояние. Однако если после вызова connect был вызван метод JMXConnector.close(), новый вызов connect вызовет исключение IOException.

В противном случае метод connect либо ещё не вызывался для этого объекта, либо вызывался, но завершился исключением. В таком случае вызов connect предпримет попытку установить подключение к серверу коннектора.

Определён в:
connect в интерфейсе JMXConnector
Параметры:
environment — свойства подключения. Свойства в этой карте имеют приоритет над свойствами карты, указанной при создании JMXConnector, если она была указана. Параметр может иметь значение null, что эквивалентно пустой карте.
Вызывает:
IOException — если подключение не удалось установить из-за проблем со связью

getConnectionId

public String getConnectionId() throws IOException
Описание скопировано из интерфейса: JMXConnector

Получает идентификатор этого подключения от сервера коннектора. Для заданного сервера коннектора каждое подключение имеет уникальный идентификатор, который не меняется в течение всего времени существования подключения.

Определён в:
getConnectionId в интерфейсе JMXConnector
Возвращает:
уникальный идентификатор этого подключения. Он совпадает с идентификатором, который сервер коннектора включает в свои уведомления JMXConnectionNotification. В package description описаны соглашения об идентификаторах подключений.
Вызывает:
IOException — если получить идентификатор подключения не удалось, например потому, что подключение закрыто или разорвано.

getMBeanServerConnection

public MBeanServerConnection getMBeanServerConnection() throws IOException
Описание скопировано из интерфейса: JMXConnector

Возвращает объект MBeanServerConnection, представляющий удалённый сервер MBean. Для заданного JMXConnector два успешных вызова этого метода обычно возвращают один и тот же объект MBeanServerConnection, хотя это не является обязательным.

При вызове любого метода возвращённого MBeanServerConnection соответствующий метод вызывается на удалённом сервере MBean. Значение, возвращённое методом сервера MBean, передаётся клиенту. Если метод сервера MBean вызывает исключение Exception, клиент получает то же исключение Exception. Если метод сервера MBean или попытка его вызова вызывает исключение Error, оно оборачивается в JMXServerErrorException, которое получает клиент: Error.

Определён в:
getMBeanServerConnection в интерфейсе JMXConnector
Возвращает:
объект, реализующий интерфейс MBeanServerConnection и перенаправляющий вызовы своих методов удалённому серверу MBean.
Вызывает:
IOException — если создать допустимый MBeanServerConnection не удалось, например потому, что подключение к удалённому серверу MBean ещё не установлено (с помощью метода connect), оно закрыто или разорвано.

addConnectionNotificationListener

public void addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
Описание скопировано из интерфейса: JMXConnector

Добавляет слушателя для получения уведомлений об изменениях состояния подключения. Слушатель будет получать уведомления типа JMXConnectionNotification. Реализация может отправлять и уведомления других типов.

С помощью этого метода можно добавить любое количество слушателей. Один и тот же слушатель можно добавлять несколько раз с одинаковыми или различными значениями фильтра и объекта обратной передачи. Повторные записи не обрабатываются особым образом. Например, если слушатель зарегистрирован дважды без фильтра, его метод handleNotification будет вызываться для каждого уведомления дважды.

Определён в:
addConnectionNotificationListener в интерфейсе JMXConnector
Параметры:
listener — слушатель, получающий уведомления о состоянии подключения.
filter — фильтр для выбора уведомлений, доставляемых слушателю, или null, если нужно доставлять все уведомления.
handback — объект, передаваемый слушателю вместе с каждым уведомлением. Может иметь значение null.
См. также:
  • JMXConnector.removeConnectionNotificationListener(NotificationListener)
  • NotificationBroadcaster.addNotificationListener(NotificationListener, NotificationFilter, Object)

removeConnectionNotificationListener

public void removeConnectionNotificationListener(NotificationListener listener) throws ListenerNotFoundException
Описание скопировано из интерфейса: JMXConnector

Удаляет слушателя из списка получающих уведомления об изменениях состояния. Слушатель должен быть предварительно добавлен. Если совпадающих слушателей несколько, удаляются все.

Определён в:
removeConnectionNotificationListener в интерфейсе JMXConnector
Параметры:
listener — слушатель, получающий уведомления о состоянии подключения.
Вызывает:
ListenerNotFoundException — если слушатель не зарегистрирован в этом JMXConnector.
См. также:
  • JMXConnector.removeConnectionNotificationListener(NotificationListener, NotificationFilter, Object)
  • JMXConnector.addConnectionNotificationListener(NotificationListener, NotificationFilter, Object)
  • NotificationEmitter.removeNotificationListener(NotificationListener, NotificationFilter, Object)

removeConnectionNotificationListener

public void removeConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException
Описание скопировано из интерфейса: JMXConnector

Удаляет слушателя из списка получающих уведомления об изменениях состояния. Слушатель должен быть предварительно добавлен с теми же тремя параметрами. Если совпадающих слушателей несколько, удаляется только один.

Определён в:
removeConnectionNotificationListener в интерфейсе JMXConnector
Параметры:
listener — слушатель, получающий уведомления о состоянии подключения.
filter — фильтр для выбора уведомлений, доставляемых слушателю. Может иметь значение null.
handback — объект, передаваемый слушателю вместе с каждым уведомлением. Может иметь значение null.
Вызывает:
ListenerNotFoundException — если слушатель не зарегистрирован в этом JMXConnector или зарегистрирован с другим фильтром либо объектом обратной передачи.
См. также:
  • JMXConnector.removeConnectionNotificationListener(NotificationListener)
  • JMXConnector.addConnectionNotificationListener(NotificationListener, NotificationFilter, Object)
  • NotificationEmitter.removeNotificationListener(NotificationListener, NotificationFilter, Object)

close

public void close() throws IOException
Описание скопировано из интерфейса: JMXConnector

Закрывает клиентское подключение к серверу. Любой выполняющийся или новый запрос с использованием MBeanServerConnection, возвращённого методом JMXConnector.getMBeanServerConnection(), приведёт к возникновению исключения IOException.

Если для этого объекта уже был успешно вызван метод close, повторный вызов не повлияет на его состояние. Если метод close ещё не вызывался или его вызов завершился исключением, будет предпринята попытка закрыть подключение. Эта попытка может завершиться успешно, и тогда метод close вернёт управление без исключений, либо привести к исключению.

Закрытие подключения может занять значительное время. Например, если сервер аварийно завершил работу, операция закрытия может ожидать истечения тайм-аута сетевого протокола. Вызывающим сторонам, которые не хотят блокироваться при закрытии, следует выполнять эту операцию в отдельном потоке.

Определён в:
close в интерфейсе AutoCloseable
Определён в:
close в интерфейсе Closeable
Определён в:
close в интерфейсе JMXConnector
Вызывает:
IOException — если подключение не удалось корректно закрыть. Если возникло это исключение, неизвестно, было ли корректно закрыто подключение со стороны сервера.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, в том числе общие сведения, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.management.rmi/javax/management/remote/rmi/RMIConnector.html

Spec-Zone.ru

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