javax.management.modelmbean
인터페이스 ModelMBeanInfo

알려진 구현 클래스 목록:

ModelMBeanInfoSupport

public interface ModelMBeanInfo

ModelMBeanInfo는 ModelMBean 마다 이 인터페이스를 구현할 필요가 있습니다. 이 인터페이스의 구현은 모든 JMX 에이전트에 부속되어 있습니다.

관리 대상이 되는 Java 자원은 MBeanServer createMBean 메서드를 사용해, ModelMBean를 인스턴스화합니다. 다음에 ModelMBean 인스턴스의 ModelMBeanInfo와 Descriptor를 설정합니다. ModelMBean ModelMBeanInfo 에서 공개된 속성, 오퍼레이션 및 통지는 관리 인터페이스를 구성합니다. 이것들에는 MBean, 커넥터, 어댑터로부터 액세스 할 수 있습니다. Descriptor를 사용해, 관리 대상 어플리케이션내의 값과 메서드를 정의해, ModelMBean 속성 및 오퍼레이션에 맵 할 수 있습니다 . 이 매핑은 파일을 사용한 개발시, 또는 실행시에 프로그램을 사용해 동적으로 정의할 수 있습니다.

MBeanServer 로 인스턴스화 된 MBean는 모두 관리 대상이 됩니다. 이러한 MBean 속성, 오퍼레이션 및 통지에는 MBeanServer에 접속된 커넥터 또는 어댑터 경유로 원격 접근 할 수 있습니다. JMX 준거의 MBean가 아닌 Java 객체는 MBeanServer에 등록할 수 없습니다. 자원은 ModelMBean를 인스턴스화하는 것으로 MBean 유효성을 보증합니다. 모든 public 메서드로 MBeanException 및 RuntimeOperationsException가 Throw 될 필요가 있습니다. 이것에 의해 분산형 통신 (RMI, EJB 등)으로부터의 예외의 랩이 가능하게 됩니다.

도입된 버전 :

1.5

메서드 개요

Object	clone () 이 객체의 복사본을 작성해, 리턴합니다.
ModelMBeanAttributeInfo	getAttribute (String inName) 이름으로 요구된 ModelMBeanAttributeInfo를 리턴합니다.
MBeanAttributeInfo []	getAttributes () 관리용의 공개 속성의 리스트를 리턴합니다.
String	getClassName () 이 MBeanInfo에 의해 기술된 MBean Java 클래스의 이름을 리턴합니다.
MBeanConstructorInfo []	getConstructors () MBean public 생성자 리스트를 리턴합니다.
String	getDescription () 인간이 읽을 수 있는 형식의 MBean 설명을 리턴합니다.
Descriptor	getDescriptor (String inDescriptorName, String inDescriptorType) 이름과 descriptorType 로 요구된 Descriptor를 리턴합니다.
Descriptor []	getDescriptors (String inDescriptorType) inDescriptorType 형의 ModelMBeanInfo 모든 Descriptor 로 구성되는 Descriptor 배열을 리턴합니다.
Descriptor	getMBeanDescriptor () MBean 전체 정책를 포함한 ModelMBean 기술자를 리턴합니다.
ModelMBeanNotificationInfo	getNotification (String inName) 이름으로 요구된 ModelMBeanNotificationInfo를 리턴합니다.
MBeanNotificationInfo []	getNotifications () MBean에 의해 발행된 통지의 리스트를 리턴합니다.
ModelMBeanOperationInfo	getOperation (String inName) 이름으로 요구된 ModelMBeanOperationInfo를 리턴합니다.
MBeanOperationInfo []	getOperations () MBean 오퍼레이션의 리스트를 리턴합니다.
void	setDescriptor (Descriptor inDescriptor, String inDescriptorType) ModelMBean inDescriptorType 형의 정보 배열내에 기술자를 설정합니다.
void	setDescriptors (Descriptor [] inDescriptors) ModelMBeanInfo에 기술자를 추가하는지, ModelMBeanInfo 내의 기술자를 옮겨놓습니다.
void	setMBeanDescriptor (Descriptor inDescriptor) ModelMBean 기술자를 설정합니다.

메서드의 상세

getDescriptors

Descriptor [] getDescriptors(String  inDescriptorType)
                            throws MBeanException,

                                   RuntimeOperationsException 

inDescriptorType 형의 ModelMBeanInfo 모든 Descriptor 로 구성되는 Descriptor 배열을 리턴합니다.

파라미터:

inDescriptorType - 리턴된 기술자에 대해서 설정할 필요가 있는 descriptorType 필드의 값. mbean, attribute, operation, constructor, notification 언젠가. null 또는 비어있는 경우, 모든 형태가 리턴된다

반환값:

형이 inDescriptorType인 경우, 이 ModelMBean 모든 기술자를 포함한 기술자 배열

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 파라미터로서 건네받은 descriptorType가 mbean, attribute, operation, constructor, notification 머지않아도 아닌 경우, 비어있는 경우, 또는 null인 경우, IllegalArgumentException을 감싸는

관련 항목:

setDescriptors(javax.management.Descriptor[])

setDescriptors

void setDescriptors(Descriptor [] inDescriptors)
                    throws MBeanException,

                           RuntimeOperationsException 

ModelMBeanInfo에 기술자를 추가하는지, ModelMBeanInfo 내의 기술자를 옮겨놓습니다.

파라미터:

inDescriptors - ModelMBeanInfo 내로 설정되는 기술자. 리스트의 null 요소는 무시된다. 모든 기술자가 name 및 descriptorType 필드를 가지고 있을 필요가 있다

예외:

RuntimeOperationsException - 기술자가 null 또는 부정한 경우, IllegalArgumentException을 랩 한다

MBeanException - 분산 통신 Exception을 감싸는

관련 항목:

getDescriptors(java.lang.String)

getDescriptor

Descriptor  getDescriptor(String  inDescriptorName,
                         String  inDescriptorType)
                         throws MBeanException,

                                RuntimeOperationsException 

이름과 descriptorType 으로 요구된 Descriptor를 리턴합니다.

파라미터:

inDescriptorName - 기술자의 이름

inDescriptorType - 요구되는 기술자의 형태. null 또는 비어있는 경우, 모든 형태가 검색된다. 유효한 형태는 mbean, attribute, constructor, operation 및 notification. 이 값은 리턴된 기술자의 descriptorType 필드와 동일해진다

반환값:

같은 이름 및 descriptorType ModelMBean 기술자를 포함한 기술자. 기술자가 발견되지 않는 경우, null이 리턴된다

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 기술자명이 null 인지, 형태가 null 또는 부정한 경우, IllegalArgumentException을 랩 한다. 형태는 mbean, attribute, constructor, operation, notification 언젠가가 아니면 안되는

관련 항목:

setDescriptor(javax.management.Descriptor, java.lang.String)

setDescriptor

void setDescriptor(Descriptor  inDescriptor,
                   String  inDescriptorType)
                   throws MBeanException,

                          RuntimeOperationsException 

ModelMBean inDescriptorType 형의 정보 배열내에 기술자를 설정합니다. 지정된 기술자를 설정하기 위해, 대응하는 ModelMBean*Info setDescriptor 메서드가 호출됩니다.

파라미터:

inDescriptor - ModelMBean 내로 설정되는 기술자. null 이외가 아니면 안된다. 모든 기술자가 name 및 descriptorType 필드를 가지고 있을 필요가 있는

inDescriptorType - 설정되는 기술자의 형태. null인 경우, 기술자의 descriptorType 필드가 사용된다. 값이 가리키는 경우, 이 값이 기술자의 descriptorType 필드로 설정되지 않으면 안 된다. mbean, attribute, constructor, operation, notification 언젠가

예외:

RuntimeOperationsException - 인수가 부정 또는 null 인 경우, 또는 대응하는 MBeanAttributeInfo, MBeanConstructorInfo, MBeanNotificationInfo, MBeanOperationInfo 어느쪽이든으로 기술자의 name 필드가 발견되지 않는 경우, IllegalArgumentException을 랩 한다

MBeanException - 분산 통신 Exception을 감싸는

관련 항목:

getDescriptor(java.lang.String, java.lang.String)

getMBeanDescriptor

Descriptor  getMBeanDescriptor()
                              throws MBeanException,

                                     RuntimeOperationsException 

MBean 전체 정책를 포함한 ModelMBean 기술자를 리턴합니다. 이 기술자에게는 MBean 메타데이타와 지속성 기능 및 캐싱 기능의 디폴트 정책가 포함됩니다.

기술자의 필드는 아래와 같이 정의가 끝난 상태입니다만, 이 내용으로 한정되지 않습니다.

 name           : MBean 명   descriptorType : 반드시 mbean    displayName    : 디스플레이로 사용되는 속성의 이름  persistPolicy  : OnUpdate, OnTimer, NoMoreOftenThan, Always, Never   persistLocation : 완전 수식 디렉토리명. MBean는 
 필요에 따라서 이 디렉토리에 보관 유지되는 persistFile    : MBean를 보관 유지하는 파일의 이름 persistPeriod  : 초수. OnTime 및 NoMoreOftenThan PersistPolicy
 지속 사이클의 빈도를 나타내는  currencyTimeLimit : 치의 유효기간. <0 항상 무효,=0 항상 유효, >0 초   log            : t인 경우는 모든 통지를 로그에 기록, f인 경우는 통지를 기록하지 않는 logfile        : 이벤트의 기록처 파일의 완전 수식 파일명 visibility     : 1 ~ 4
 값 가운데,1: 항상 가시,4: 거의 불가시 export         : 이 MBean를 export 또는 공개할 때 사용하는 이름. 다른 JMX 에이전트는 이 이름을 사용해 MBean를 검색하는    presentationString : 데이터 표현과 MBean를 관련짓기 위한 XML 형식의 캐릭터 라인

디폴트의 기술자는 name=mbeanName, descriptorType=mbean, displayName=this.getClassName(), persistPolicy=never, log=F, export=F, visibility=1 입니다. 기술자에게 이러한 몇개의 필드가 부족한 경우, 부족한 필드가 기본값 로 추가됩니다.

주: 이전의 버전의 사양과의 부정합이 있기 때문에 currencyTimeLimit에는 제로 아래의 값을 사용하지 않게의해 주세요. 캐쉬에 들어간 값이 유효하지 않은 것을 나타내고 싶은 경우는 currencyTimeLimit 필드를 생략 합니다. 이 값이 항상 유효한 것을 나타내고 싶은 경우는 이 필드에 매우 큰 값을 지정합니다.

반환값:

MBean 기술자

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 기술자의 취득시에 RuntimeException이 발생했을 경우

관련 항목:

setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor

void setMBeanDescriptor(Descriptor  inDescriptor)
                        throws MBeanException,

                               RuntimeOperationsException 

ModelMBean 기술자를 설정합니다. 이 기술자에게는 MBean에 관한 MBean 전체의 디폴트의 메타데이타와 지속성 기능 및 캐싱 기능의 디폴트 정책가 포함됩니다. 이 오퍼레이션은 기술자를 완전하게 치환합니다. 머지는 실시하지 않습니다. 기술자가 null 로 설정되었을 경우, 디폴트의 기술자가 작성됩니다. 디폴트의 기술자는 name=mbeanName, descriptorType=mbean, displayName=this.getClassName(), persistPolicy=never, log=F, export=F, visibility=1 입니다. 기술자에게 이러한 몇개의 필드가 부족한 경우, 부족한 필드가 기본값 로 추가됩니다. 유효한 필드명에 대해서는 getMBeanDescriptor 메서드의 javadoc를 참조하십시오.

파라미터:

inDescriptor - 설정하는 기술자

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 기술자가 무효인 경우, IllegalArgumentException을 감싸는

관련 항목:

getMBeanDescriptor()

getAttribute

ModelMBeanAttributeInfo  getAttribute(String  inName)
                                     throws MBeanException,

                                            RuntimeOperationsException 

이름으로 요구된 ModelMBeanAttributeInfo를 리턴합니다.

파라미터:

inName - 얻는 ModelMBeanAttributeInfo 이름. 이 이름의 ModelMBeanAttributeInfo가 존재하지 않는 경우는 null이 리턴된다

반환값:

지정된 속성의 속성 정보. 존재하지 않는 경우는 null

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 속성명이 null인 경우 IllegalArgumentException을 랩 한다

getOperation

ModelMBeanOperationInfo  getOperation(String  inName)
                                     throws MBeanException,

                                            RuntimeOperationsException 

이름으로 요구된 ModelMBeanOperationInfo를 리턴합니다.

파라미터:

inName - 얻는 ModelMBeanOperationInfo 이름. 이 이름의 ModelMBeanOperationInfo가 존재하지 않는 경우는 null이 리턴된다

반환값:

지정된 오퍼레이션의 오퍼레이션 정보. 존재하지 않는 경우는 null

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 오퍼레이션명이 null인 경우 IllegalArgumentException을 랩 한다

getNotification

ModelMBeanNotificationInfo  getNotification(String  inName)
                                           throws MBeanException,

                                                  RuntimeOperationsException 

이름으로 요구된 ModelMBeanNotificationInfo를 리턴합니다.

파라미터:

inName - 얻는 ModelMBeanNotificationInfo 이름. 이 이름의 ModelMBeanNotificationInfo가 존재하지 않는 경우는 null이 리턴된다

반환값:

지정된 통지의 정보. 존재하지 않는 경우는 null

예외:

MBeanException - 분산 통신 Exception을 랩 한다

RuntimeOperationsException - 통지명이 null인 경우 IllegalArgumentException을 랩 한다

clone

Object  clone()

이 객체의 복사본을 작성해, 리턴합니다.

getAttributes

MBeanAttributeInfo [] getAttributes()

관리용의 공개 속성의 리스트를 리턴합니다. 각 속성은 MBeanAttributeInfo 객체에 의해 기술됩니다.

반환값:

MBeanAttributeInfo 객체의 배열

getClassName

String  getClassName()

이 MBeanInfo에 의해 기술된 MBean Java 클래스의 이름을 리턴합니다.

반환값:

Java 클래스명

getConstructors

MBeanConstructorInfo [] getConstructors()

MBean public 생성자 리스트를 리턴합니다. 각 생성자는 MBeanConstructorInfo 객체에 의해 기술됩니다.

반환값:

MBeanConstructorInfo 객체의 배열

getDescription

String  getDescription()

인간이 읽을 수 있는 형식의 MBean 설명을 리턴합니다.

반환값:

설명

getNotifications

MBeanNotificationInfo [] getNotifications()

MBean에 의해 발행된 통지의 리스트를 리턴합니다. 각 통지는 MBeanNotificationInfo 객체에 의해 기술됩니다.

ModelMBean는 어플리케이션에 의해 지정된 통지 외에 항상 2개의 추가 통지를 송신할 수 있습니다.

• 1개는 기술자명이 GENERIC, displayName 이 jmx.modelmbean.generic 통지
• 이제(이미 ) 1개는 기술자명이 ATTRIBUTE_CHANGE, displayName가 jmx.attribute.change 표준 속성 변경 통지

모든 ModelMBeanInfo 구현은 어플리케이션에 의해 지정된 통지에 반드시 이 2개의 통지를 추가합니다.

반환값:

MBeanNotificationInfo 객체의 배열

getOperations

MBeanOperationInfo [] getOperations()

MBean 오퍼레이션의 리스트를 리턴합니다. 각 오퍼레이션은 MBeanOperationInfo 객체에 의해 기술됩니다.

반환값:

MBeanOperationInfo 객체의 배열