Интерфейс JMXConnectorServerMBean

Все известные реализующие классы:: JMXConnectorServer, RMIConnectorServer

public interface JMXConnectorServerMBean

Интерфейс MBean для серверов соединений. Сервер соединений JMX API прикреплен к серверу MBean и устанавливает соединения с этим сервером MBean для удаленных клиентов.

Недавно созданный сервер соединений неактивен и еще не прослушивает соединения. Он начинает прослушивать соединения только после вызова метода start.

С:: 1.5

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

Модификатор и тип	Метод	Описание
`JMXServiceURL`	`getAddress()`	Адрес этого сервера соединений.
`Map<String,?>`	`getAttributes()`	Атрибуты этого сервера соединений.
`String[]`	`getConnectionIds()`	Список идентификаторов активных соединений с этим сервером соединений.
`boolean`	`isActive()`	Определяет, активен ли сервер соединений.
`void`	`setMBeanServerForwarder(MBeanServerForwarder mbsf)`	Вставляет объект, который перехватывает запросы к серверу MBean, поступающие через этот сервер соединений.
`void`	`start()`	Активирует сервер соединений, то есть начинает прослушивать соединения клиентов.
`void`	`stop()`	Деактивирует сервер соединений, то есть прекращает прослушивание соединений клиентов.
`JMXConnector`	`toJMXConnector(Map<String,?> env)`	Возвращает заглушку клиента для этого сервера соединений.

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

start

void start() throws IOException

Активирует сервер соединений, то есть начинает прослушивание соединений клиентов. Вызов этого метода, когда сервер соединений уже активен, не имеет эффекта. Вызов этого метода, когда сервер соединений остановлен, вызовет исключение IOException.

Исключение:: IOException - если невозможно начать прослушивание или сервер соединений остановлен.; IllegalStateException - если сервер соединений не прикреплен к серверу MBean.

stop

void stop() throws IOException

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

После остановки сервера соединений его нельзя запустить снова.

Вызов этого метода, когда сервер соединений уже остановлен, не имеет эффекта. Вызов этого метода, когда сервер соединений еще не запущен, приведет к постоянной деактивации объекта сервера соединений.

Если при закрытии соединения клиента возникает исключение, это исключение не выводится из этого метода. JMXConnectionNotification с типом JMXConnectionNotification.FAILED отправляется из этого MBean с идентификатором соединения, которое не удалось закрыть.

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

Исключение:: IOException - если сервер нельзя закрыть корректно. Когда это исключение выбрасывается, сервер уже попытался закрыть все подключения клиентов. Все подключения клиентов закрываются, за исключением, возможно, тех, которые вызвали исключения при попытке сервера их закрыть.

isActive

boolean isActive()

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

Возвращает:: true, если сервер соединений активен.

setMBeanServerForwarder

void setMBeanServerForwarder(MBeanServerForwarder mbsf)

Вставляет объект, который перехватывает запросы к серверу MBean, поступающие через этот сервер соединений. Этот объект будет предоставлен в качестве MBeanServer для любого нового подключения, созданного этим сервером соединений. Существующие соединения не затрагиваются.

Этот метод может вызываться более одного раза с различными объектами MBeanServerForwarder. Результатом является цепочка перенаправляющих объектов. Последний добавленный перенаправляющий объект стоит первым в цепочке. Подробнее:

Если этому серверу соединений уже связан объект MBeanServer, то этот объект передается методу mbsf.setMBeanServer. Если при этом возникает исключение, этот метод выбрасывает то же самое исключение без каких-либо других последствий.
Если этот сервер соединений еще не связан с объектом MBeanServer, или если вызов mbsf.setMBeanServer (указанный выше) завершился успешно, то mbsf становится перенаправляющим объектом MBeanServer этого сервера соединений.

Параметры:: mbsf - новый перенаправляющий объект MBeanServerForwarder.
Исключение:: IllegalArgumentException - если вызов mbsf.setMBeanServer завершается с исключением IllegalArgumentException. Это включает случай, когда mbsf равно null.

getConnectionIds

String[] getConnectionIds()

Список идентификаторов активных соединений с этим сервером соединений.

Возвращает:: новый массив строк, содержащий список идентификаторов. Если активных соединений нет, этот массив будет пустым.

getAddress

JMXServiceURL getAddress()

Адрес этого сервера соединений.

Возвращаемый адрес может не совпадать с исходным JMXServiceURL, предоставленным при создании сервера соединений, так как исходный адрес может не быть полным. Например, номер порта может быть динамически назначен при запуске сервера соединений. Вместо этого возвращаемый адрес — фактический JMXServiceURL JMXConnectorServer. Это адрес, который клиенты предоставляют методу JMXConnectorFactory.connect(JMXServiceURL).

Обратите внимание, что возвращаемый адрес может быть null, если сервер JMXConnectorServer еще не active.

Возвращает:: адрес этого сервера соединений или null, если он отсутствует.

getAttributes

Map<String,?> getAttributes()

Атрибуты этого сервера соединений.

Возвращает:: только для чтения карту, содержащую атрибуты этого сервера соединений. Атрибуты, значения которых не сериализуемы, исключаются из этой карты. Если нет сериализуемых атрибутов, возвращаемая карта пуста.

toJMXConnector

JMXConnector toJMXConnector(Map<String,?> env) throws IOException

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

Данный сервер соединений может не поддерживать создание заглушек клиентов. Однако серверы соединений, указанные в JMX Remote API (JMXMP Connector и RMI Connector), это поддерживают.

Параметры:: env - параметры подключения клиента, аналогичные параметрам, которые могут быть переданы в метод JMXConnector.connect(Map). Может быть null, что эквивалентно пустой карте.
Возвращает:: заглушку клиента, которая может быть использована для создания нового подключения к этому серверу соединений.
Исключение:: UnsupportedOperationException - если этот сервер соединений не поддерживает создание заглушек клиентов.; IllegalStateException - если JMXConnectorServer не запущен (см. isActive()).; IOException - если проблема с коммуникацией препятствует созданию заглушки.

© 1993, 2021, 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/17/docs/api/java.management/javax/management/remote/JMXConnectorServerMBean.html