javax.management.remote
인터페이스 JMXConnector

모든 슈퍼 인터페이스:

Closeable

기존의 구현 클래스의 일람:

RMIConnector

public interface JMXConnector
extends Closeable 

JMX API 연결기의 클라이언트측입니다. 이 형태의 객체는, 연결기 서버에 접속하기 위해서 사용할 수 있습니다.

이 형태의 새롭게 작성된 객체는 접속되고 있지 않습니다. 이 객체를 사용하기 위해서는,connect 메소드를 호출할 필요가 있습니다. 다만,JMXConnectorFactory.connect 로 작성된 객체는 벌써 접속되고 있습니다.

도입된 버젼:

1.5

필드의 개요

static String

CREDENTIALS 접속중에 연결기 서버에 송신하는 증명서를 지정하는 속성의 이름입니다.

메소드의 개요

void	addConnectionNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) 접속 상태의 변화가 통지되는 청취자를 추가합니다.
void	close () 클라이언트와 서버의 접속을 종료합니다.
void	connect () 연결기 서버와의 접속을 확립합니다.
void	connect (Map <String ,? > env) 연결기 서버와의 접속을 확립합니다.
String	getConnectionId () 연결기 서버로부터, 이 접속의 ID 를 가져옵니다.
MBeanServerConnection	getMBeanServerConnection () 원격 MBean 서버를 나타내는 MBeanServerConnection 객체를 돌려줍니다.
MBeanServerConnection	getMBeanServerConnection (Subject delegationSubject) 제공된 위양 대상 대신에 오퍼레이션을 실행하는, 원격 MBean 서버를 나타내는 MBeanServerConnection 객체를 돌려줍니다.
void	removeConnectionNotificationListener (NotificationListener listener) 상태의 변경이 통지되는 청취자를 리스트로부터 삭제합니다.
void	removeConnectionNotificationListener (NotificationListener l, NotificationFilter f, Object handback) 상태의 변경이 통지되는 청취자를 리스트로부터 삭제합니다.

필드의 상세

CREDENTIALS

static final String  CREDENTIALS

접속중에 연결기 서버에 송신하는 증명서를 지정하는 속성의 이름입니다. 이 속성에 관련지을 수 있었던 값은, 서버 JMXAuthenticator 의 적절한 형태의 직렬화 가능한 객체입니다.

관련 항목:

정수 필드치

메소드의 상세

connect

void connect()
             throws IOException 

연결기 서버와의 접속을 확립합니다. 이 메소드는,connect(null) 와 동등합니다.

예외:

IOException - 통신 장해에 의해 접속을 확립할 수 없었던 경우

SecurityException - 시큐리티상의 이유에 의해 접속을 확립할 수 없었던 경우

connect

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

연결기 서버와의 접속을 확립합니다.

이 객체상에서, 벌써 connect 가 불려 가고 있는 경우, 이제 1 회 호출해도 아무것도 일어나지 않습니다. 한편,connect 의 나중에 close() 가 불려 가고 있는 경우, 재차 connect 를 호출하면(자) IOException 가 throw 됩니다.

이 객체상에서 connect 가 1 회도 불려 가지 않은 경우, 또는, 호출에 대해서 예외가 생성되었을 경우,connect 를 호출하면(자) 연결기 서버와의 접속이 시행됩니다.

파라미터:

env - 접속의 프로퍼티. 이 맵내의 프로퍼티은,JMXConnector 의 작성시로 지정된 맵내의 프로퍼티을 오버라이드(override) 한다 (존재하는 경우). 이 파라미터가 null 의 경우, 빈 상태(empty)의 맵을 지정했을 경우와 같은 것이 된다

예외:

IOException - 통신 장해에 의해 접속을 확립할 수 없었던 경우

SecurityException - 시큐리티상의 이유에 의해 접속을 확립할 수 없었던 경우

getMBeanServerConnection

MBeanServerConnection  getMBeanServerConnection()
                                               throws IOException 

원격 MBean 서버를 나타내는 MBeanServerConnection 객체를 돌려줍니다. 일반적으로,JMXConnector 에 대해서 이 메소드를 2 회 호출했을 경우, 각 호출로 같은 MBeanServerConnection 객체가 돌려주어집니다. 다만, 이것은 필수 조건이 아닙니다.

반환된 MBeanServerConnection 내의 각 메소드에 대해서 이 메소드를 호출하면(자), 원격 MBean 서버내의 대응하는 메소드가 불려 갑니다. MBean 서버 메소드에 의해 반환되는 값이, 클라이언트에 반환되는 값이 됩니다. MBean 서버 메소드가 Exception 를 throw 했을 경우, 클라이언트에는 같은 Exception 가 돌려주어집니다. MBean 서버 메소드 자체, 또는 그 호출의 시행으로 Error 가 발생했을 경우, 클라이언트에는, 발생한 Error 를 랩 하는 JMXServerErrorException 가 돌려주어집니다.

이 메소드의 호출은,getMBeanServerConnection(null) 의 호출과 동등합니다. 위양 대상이 지정되지 않고,MBeanServerConnection 상에서 불려 간 모든 오퍼레이션은 인증 대상 (존재하는 경우)을 사용할 필요가 있습니다.

반환값:

메소드를 원격 MBean 서버에 전송 하는 것으로써 MBeanServerConnection 인터페이스를 구현하는 객체

예외:

IOException - 유효한 MBeanServerConnection 를 작성할 수 없는 경우. 예를 들어, connect 메소드에 의한 원격 MBean 서버와의 접속이 아직 확립되어 있지 않은 경우, MBean 서버와의 접속이 벌써 종료하고 있는 경우, 접속이 중단되었을 경우 등

getMBeanServerConnection

MBeanServerConnection  getMBeanServerConnection(Subject  delegationSubject)
                                               throws IOException 

제공된 위양 대상 대신에 오퍼레이션을 실행하는, 원격 MBean 서버를 나타내는 MBeanServerConnection 객체를 돌려줍니다. 일반적으로,JMXConnector 및 Subject 에 대해서 이 메소드를 2 회 호출했을 경우, 각 호출로 같은 MBeanServerConnection 객체가 돌려주어집니다. 다만, 이것은 필수 조건이 아닙니다.

반환된 MBeanServerConnection 내의 각 메소드에 대해서 이 메소드를 호출하면(자), 인증 대상은 아니고 위양 대상에 대신해, 원격 MBean 서버내의 대응하는 메소드가 불려 갑니다. MBean 서버 메소드에 의해 반환되는 값이, 클라이언트에 반환되는 값이 됩니다. MBean 서버 메소드가 Exception 를 throw 했을 경우, 클라이언트에는 같은 Exception 가 돌려주어집니다. MBean 서버 메소드 자체, 또는 그 호출의 시행으로 Error 가 발생했을 경우, 클라이언트에는, 발생한 Error 를 랩 하는 JMXServerErrorException 가 돌려주어집니다.

파라미터:

delegationSubject - Subject. 이것 대신에 요구가 실행된다. null 의 경우, 인증이 끝난 Subject 대신에 요구가 실행된다 (존재하는 경우)

반환값:

메소드를 원격 MBean 서버에 전송 하는 것으로써, 위양 대상 대신에 MBeanServerConnection 인터페이스를 구현하는 객체

예외:

IOException - 유효한 MBeanServerConnection 를 작성할 수 없는 경우. 예를 들어, connect 메소드에 의한 원격 MBean 서버와의 접속이 아직 확립되어 있지 않은 경우, MBean 서버와의 접속이 벌써 종료하고 있는 경우, 접속이 중단되었을 경우 등

close

void close()
           throws IOException 

클라이언트와 서버의 접속을 종료합니다. 현행의 요구 또는 새로운 요구가,getMBeanServerConnection() 로부터 반환되는 MBeanServerConnection 를 사용하는 경우,IOException 가 throw 됩니다.

이 객체상에서, 벌써 close 가 불려 가고 있는 경우, 이제 1 회 호출해도 아무것도 일어나지 않습니다. close 가 1 회도 불려 가지 않은 경우, 또는, 호출에 대해서 예외가 생성되었을 경우는, 접속의 종료가 시행됩니다. 이 시행에 성공했을 경우,close 는 일반적으로 대로 종료합니다. 실패했을 경우는 예외가 생성되는 일이 있습니다.

접속의 종료는, 시간이 걸리는 오퍼레이션입니다. 예를 들어 서버가 크래쉬 했을 경우, 종료 오퍼레이션은 네트워크 프로토콜의 타임 아웃까지 중단될 가능성이 있습니다. 종료 오퍼레이션의 도중에 기다리게 되고 싶지 않은 경우는, 별thread로 실행해 주세요.

정의:

인터페이스 Closeable 내의 close

예외:

IOException - 접속을 정상적으로 종료할 수 없는 경우. 이 예외가 throw 되었을 경우, 접속의 서버측이 정상적으로 종료했는지 어떠했는지는 불명

addConnectionNotificationListener

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

접속 상태의 변화가 통지되는 청취자를 추가합니다. 이 청취자는,JMXConnectionNotification 형의 통지를 수신합니다. 구현에 의해, 이외의 형태의 통지가 송신되는 경우도 있습니다.

이 메소드에 추가할 수 있는 청취자의 수에 제한은 없습니다. 필터와 핸드백에 동일한 값 또는 다른 값을 지정해, 동일한 청취자를 반복해 추가하는 일도 가능합니다. 복제 엔트리도 특별 취급 되지 않습니다. 예를 들어, 청취자를 필터없이 2 회 등록했을 경우, 각 통지로, 이 청취자의 handleNotification 메소드가 2 회 불려 갑니다.

파라미터:

listener - 접속 상태 통지를 받는다 청취자

filter - 청취자에게 전달되는 통지를 선택하는 필터. 모든 통지를 전달하는 경우는 null

handback - 각 통지와 함께 청취자에게 건네받는 객체. null 도 가능

예외:

NullPointerException - listener 가 null 의 경우

관련 항목:

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 가 null 의 경우

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 

상태의 변경이 통지되는 청취자를 리스트로부터 삭제합니다. 삭제 대상으로 해 지정할 수 있는 것은, 이전에 같은 3 개의 파라미터로 추가된 청취자만입니다. 조건에 해당하는 청취자가 복수 존재하는 경우도, 삭제되는 것은 1 개(살) 뿐입니다.

파라미터:

l - 접속 상태 통지를 받는 청취자

f - 청취자에게 전달된다 통지를 선택하는 필터. null 도 가능

handback - 각 통지와 함께 청취자에게 건네받는 객체. null 도 가능

예외:

ListenerNotFoundException - 청취자가 이 JMXConnector 에 등록되지 않은 경우, 또는 지정된 필터 및 핸드백으로 등록되지 않은 경우

관련 항목:

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 는 접속의 수명이 다할 때까지 바뀌지 않습니다.

반환값:

이 접속의 일의의 ID. 연결기 서버가 JMXConnectionNotification 에 포함하는 ID 와 같다. package description 는 접속 ID 의 규약의 설명

예외:

IOException - 접속의 종료, 중단등이 원인으로 접속 ID 를 취득할 수 없는 경우