compact3

javax.management.remote

Интерфейс JMXConnector

Все Суперинтерфейсы:

AutoCloseable, Closeable

Все Известные Классы с реализацией:

RMIConnector

public interface JMXConnector
extends Closeable

Клиентский конец соединителя API JMX. Объект этого типа может использоваться, чтобы установить соединение с сервером соединителя.

Недавно создаваемый объект этого типа несвязан. connect метод нужно вызвать прежде, чем он сможет использоваться. Однако, объекты, создаваемые JMXConnectorFactory.connect уже соединяются.

С тех пор:

1.5

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
static String	УЧЕТНЫЕ ДАННЫЕ Имя атрибута, который определяет учетные данные, чтобы передаться к серверу соединителя во время соединения.

Сводка метода

Модификатор и Тип	Метод и Описание
void	addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Добавляет слушатель, чтобы быть информированным об изменениях в состоянии соединения.
void	close() Закрывает клиентское соединение с его сервером.
void	connect() Устанавливает соединение с сервером соединителя.
void	connect(Map<String,?> env) Устанавливает соединение с сервером соединителя.
Строка	getConnectionId() Получает ID этого соединения от сервера соединителя.
MBeanServerConnection	getMBeanServerConnection() Возвраты MBeanServerConnection объект, представляющий удаленный сервер MBean.
MBeanServerConnection	getMBeanServerConnection(Subject delegationSubject) Возвраты MBeanServerConnection объект, представляющий удаленный сервер MBean, на котором операции выполняются от имени предоставленного предмета делегации.
void	removeConnectionNotificationListener(NotificationListener listener) Удаляет слушателя из списка, который будет информирован об изменениях в состоянии.
void	removeConnectionNotificationListener(NotificationListener l, NotificationFilter f, Object handback) Удаляет слушателя из списка, который будет информирован об изменениях в состоянии.

Полевая Деталь

УЧЕТНЫЕ ДАННЫЕ

static final String CREDENTIALS

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

См. Также:

Постоянные Значения полей

Деталь метода

соединиться

void connect()
      throws IOException

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

Броски:

IOException - если соединение не могло бы быть сделано из-за проблемы коммуникации.

SecurityException - если соединение не могло бы быть сделано для соображений безопасности.

соединиться

void connect(Map<String,?> env)
      throws IOException

Устанавливает соединение с сервером соединителя.

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

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

Параметры:

env - свойства соединения. Свойства в этой карте переопределяют свойства в карте, определенной когда JMXConnector создавался, если любой. Этот параметр может быть нулем, который эквивалентен пустой карте.

Броски:

IOException - если соединение не могло бы быть сделано из-за проблемы коммуникации.

SecurityException - если соединение не могло бы быть сделано для соображений безопасности.

getMBeanServerConnection

MBeanServerConnection getMBeanServerConnection()
                                        throws IOException

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

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

Вызов этого метода эквивалентен вызову getMBeanServerConnection(null) означать, что никакой предмет делегации не определяется и что все операции, к которым обращаются MBeanServerConnection должен использовать аутентифицируемый предмет, если любой.

Возвраты:

объект, который реализует MBeanServerConnection интерфейс, передавая его методы удаленному серверу MBean.

Броски:

IOException - если допустимое MBeanServerConnection не может быть создан, например потому что соединение с удаленным сервером MBean еще не было установлено (с connect метод), или это было закрыто, или это повредилось.

getMBeanServerConnection

MBeanServerConnection getMBeanServerConnection(Subject delegationSubject)
                                        throws IOException

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

Для каждого метода в возвращенном MBeanServerConnection, вызов метода заставляет соответствующий метод быть призванным удаленный сервер MBean от имени данного предмета делегации вместо аутентифицируемого предмета. Значение, возвращенное методом сервера MBean, является значением, возвращенным клиенту. Если метод сервера MBean производит Exception, то же самое Exception замечается клиентом. Если метод сервера MBean, или попытка вызвать это, производит Error, Error обертывается в a JMXServerErrorException, который замечается клиентом.

Параметры:

delegationSubject - Subject от имени которого будут выполняться запросы. Может быть нуль, когда запросы будут выполняться от имени аутентифицируемого Предмета, если любой.

Возвраты:

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

Броски:

IOException - если допустимое MBeanServerConnection не может быть создан, например потому что соединение с удаленным сервером MBean еще не было установлено (с connect метод), или это было закрыто, или это повредилось.

близко

void close()
    throws IOException

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

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

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

Определенный:

close в интерфейсе AutoCloseable

Определенный:

close в интерфейсе Closeable

Броски:

IOException - если соединение не может быть закрыто чисто. Если это исключение выдается, не известно, был ли конец сервера соединения чисто закрыт.

addConnectionNotificationListener

void addConnectionNotificationListener(NotificationListener listener,
                                       NotificationFilter filter,
                                       Object handback)

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

Любое число слушателей может быть добавлено с этим методом. Тот же самый слушатель может быть добавлен не раз с теми же самыми или различными значениями для фильтра и handback. Нет никакого специального режима двойной записи. Например, если слушатель регистрируется дважды без фильтра, то handleNotification метод вызовут дважды для каждого уведомления.

Параметры:

listener - слушатель, чтобы получить уведомления о состоянии соединения.

filter - фильтр, чтобы выбрать, какие уведомления должны быть поставлены слушателю, или нулю, если все уведомления должны быть поставлены.

handback - объект, который будет дан слушателю наряду с каждым уведомлением. Может быть нуль.

Броски:

NullPointerException - если listener нуль.

См. Также:

removeConnectionNotificationListener(javax.management.NotificationListener), NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

removeConnectionNotificationListener

void removeConnectionNotificationListener(NotificationListener listener)
                                   throws ListenerNotFoundException

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

Параметры:

listener - слушатель, чтобы получить уведомления о состоянии соединения.

Броски:

NullPointerException - если listener нуль.

ListenerNotFoundException - если слушатель не регистрируется в этом JMXConnector.

См. Также:

removeConnectionNotificationListener(NotificationListener, NotificationFilter, Object), addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

removeConnectionNotificationListener

void removeConnectionNotificationListener(NotificationListener l,
                                          NotificationFilter f,
                                          Object handback)
                                   throws ListenerNotFoundException

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

Параметры:

l - слушатель, чтобы получить уведомления о состоянии соединения.

f - фильтр, чтобы выбрать, какие уведомления должны быть поставлены слушателю. Может быть нуль.

handback - объект, который будет дан слушателю наряду с каждым уведомлением. Может быть нуль.

Броски:

ListenerNotFoundException - если слушатель не регистрируется в этом JMXConnector, или не регистрируется в данном фильтре и handback.

См. Также:

removeConnectionNotificationListener(NotificationListener), addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

getConnectionId

String getConnectionId()
                throws IOException

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

Возвраты:

уникальный ID этого соединения. Это - то же самое как ID, который сервер соединителя включает в JMXConnectionNotifications. package description описывает соглашения для ID соединения.

Броски:

IOException - если ID соединения не может быть получен, например потому что соединение закрывается или повреждается.