javax.management
클래스 ObjectName

java.lang.Object 
  javax.management.ObjectName

모든 구현된 인터페이스:

Serializable, QueryExp

public class ObjectName
extends Object 
implements QueryExp,
 Serializable 

MBean 객체명, 또는 복수의 MBean 명에 일치하는 패턴을 나타냅니다. 이 클래스의 인스턴스는 불변입니다.

이 클래스의 인스턴스를 사용해, 다음의 항목을 표현할 수 있습니다 .

• 객체명
• 쿼리의 컨텍스트 내의 객체명 패턴

객체명은 도메인의 부분과 키의 프로퍼티의 부분으로부터 완성됩니다.

「도메인」은 구두점 (:)을 포함하지 않는 캐릭터 라인입니다.

도메인에와 일드 카드 문자의 asterisk (*)나 물음표 (? )(이)가 포함되어 있는 경우, 객체명은 패턴입니다. asterisk는 0 개 이상의 캐릭터 라인을 나타냅니다. 물음표는 단일의 문자를 나타냅니다.

도메인이 비어있는 경우, 이 부분은 ObjectName를 사용하는 MBean 서버의 「디폴트 도메인」으로 옮겨놓을 수 있는 경우가 있습니다.

「키의 프로퍼티」는 키와 그 값세트입니다. 이러한 줄 순서는 뿔뿔이 흩어집니다.

개개의 「키」는 공문자열 이외의 캐릭터 라인으로 콤마 (, ), 등호 (=), 구두점, asterisk, 물음표등을 포함할 수 없습니다. 또, 특정의 ObjectName 내에 같은 키를 중복의해 포함할 수 없습니다.

키 1개에 대해, 「값」이 1개 씩 할당할 수 있습니다. 이 값은 인용부호로 둘러싸인 캐릭터 라인인가 인용부호로 둘러싸이지 않은 캐릭터 라인입니다.

「인용부호로 둘러싸이지 않은 값」은 공문자열의 가능성이 있습니다. 이 캐릭터 라인에는 콤마, 등호, 구두점, 인용부호, asterisk, 물음표등을 포함할 수 없습니다.

「인용부호로 둘러싸인 값」은 이중 인용부호 (")로 둘러싸인 공문자열의 가능성이 있습니다. 캐릭터 라인내의 backslash (\)에는 특별한 미가 있습니다. backslash의 뒤에는 다음의 몇개의 문자가 계속됩니다.

• backslash. 2번째의 backslash에는 특별한 미는 없다. 2번째의 backslash는 단일의 backslash를 나타낸다
• 「n」. 전치 된 backslash와 1 조로 단일의 복귀 개행 (Java에 있어서의 '\n')을 나타낸다
• 인용부호. 전치 된 backslash와 1 조로 단일의 인용부호를 나타낸다. 이 인용부호는 「닫는다」인용부호라고는 보여지지 않는다. 인용부호로 둘러싸인 값을 유효하게 하려면, 이것과는 별도로 「닫는다」인용부호를 지정할 필요가 있다
• 물음표 (? ) 또는 asterisk (*). backslash와 1 조로 단일의 물음표 또는 asterisk를 나타낸다

인용부호로 둘러싸인 값의 안쪽에 인용부호, 물음표, asterisk를 삽입할 수 없습니다. 다만, 홀수개의 backslash의 직후로는 삽입 가능합니다.

인용부호로 둘러싸인 값의 인용부호 부분과 그 값의 안쪽의 backslash는 값의 일부라고 보여집니다.

ObjectName는 0 개 이상의 키와 값의 편성을 가지는 경우, 「프로퍼티 패턴」이 됩니다. 도메인이 일치해, 동일한 키와 값의 편성을 가지는 (그 외의 키와 값이 존재하고 있어도 괜찮다), 패턴이 아닌 ObjectName에 일치합니다.

ObjectName는 도메인에와 일드 카드가 포함되는지, ObjectName가 프로퍼티 패턴의 경우, 패턴이 됩니다.

ObjectName가 패턴이 아닌 경우, 키의 값의 편성을 1개 이상 가지고 있을 필요가 있습니다.

ObjectName는 순서에 다음의 요소를 가지는 String 로서 출력가능합니다.

• 도메인
• 구두점 (:)
• 키의 프로퍼티 리스트 (정의는 아래와 같이)

String 로서 출력해진 키의 프로퍼티 리스트는 콤마 단락 형식의 요소 리스트가 됩니다. 각 요소는 asterisk나 키의 프로퍼티입니다. 키의 프로퍼티는 키, 등호 (=), 값으로부터 완성됩니다.

키의 프로퍼티 리스트의 요소로서 최대 1개의 asterisk를 포함할 수 있습니다 . 키의 프로퍼티 리스트에 asterisk 요소가 포함되는 경우, ObjectName는 프로퍼티 패턴이 됩니다.

ObjectName를 나타내는 String 내의 공백 문자에 특별한 미는 없습니다. 예를 들어 다음의 String에 대해 생각해 봅시다.

 domain: key1 = value1,
 key2 = value2
 

이 String는 2개의 키를 가지는 ObjectName를 나타냅니다. 키의 이름은 각각 6 문자 (최초와 마지막 문자는 공백 문자)입니다. 키의 값 " key1 " 전후에도 공백 문자가 들어가 있습니다.

상기의 문자 제약외, 인용부호로 둘러싸여 있는지를 불문하고, ObjectName 목의 부분 (도메인 부분, 키 부분, 값부분)에도, 복귀 개행 문자 ('\n')를 포함할 수 없다고 하는 제약이 있습니다. 다만, \n 첨부의 인용부호로 둘러싸인 값에는 복귀 개행 문자를 포함할 수 있습니다 .

특수 문자와 인용부호의 사용 방법에 관한 규칙은 ObjectName 작성에 사용하는 생성자 종류를 불문하고 적용됩니다.

다른 복수의 벤더로부터 제공된 MBean 충돌을 피하기 위해서는 MBean를 지정하는 조직의 역 DNS 명, 피리어드, 그 조직에 의해 해석이 결정되는 캐릭터 라인으로부터 완성되는 도메인명을 붙이면 좋을 것입니다. 예를 들어 Sun Microsystems Inc. 지정의 MBean인 경우, DNS 명 sun.com 도메인은 com.sun.MyDomain와 같이 됩니다. 이것은 Java 언어 패키지명의 규칙과 기본적으로 같습니다.

도입된 버전 :

1.5

관련 항목:

직렬화 된 형식

생성자 개요

ObjectName (String name)
캐릭터 라인을 지정해 객체명을 작성합니다.

ObjectName (String domain, Hashtable table)
Hashtable 로부터, 키의 프로퍼티를 복수 가지는 객체명을 작성합니다.

ObjectName (String domain, String key, String value)
키의 프로퍼티를 1개 만 가지는 객체명을 작성합니다.

메서드 개요

boolean	apply (ObjectName name) 이 ObjectName (패턴의 가능성이 있다)이 다른 ObjectName와 일치할지 어떨지를 테스트합니다.
boolean	equals (Object object) 현재의 객체명과 다른 객체명을 비교합니다.
String	getCanonicalKeyPropertyListString () 자구순서에 늘어놓을 수 있었던 키의 프로퍼티 리스트의 캐릭터 라인 표현을 리턴합니다.
String	getCanonicalName () 정규 형식의 이름, 즉 프로퍼티를 자구순서 (lexical order)에 늘어놓은 캐릭터 라인 표현을 리턴합니다.
String	getDomain () 도메인 부분을 리턴합니다.
static ObjectName	getInstance (ObjectName name) 지정된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다.
static ObjectName	getInstance (String name) 새로운 ObjectName(name) 로 취득된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다.
static ObjectName	getInstance (String domain, Hashtable table) 새로운 ObjectName(domain, table) 로 취득된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다.
static ObjectName	getInstance (String domain, String key, String value) 새로운 ObjectName(domain, key, value) 로 취득된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다.
String	getKeyProperty (String property) 키의 프로퍼티의 키 부분에 관련된 값을 취득합니다.
Hashtable	getKeyPropertyList () 키의 프로퍼티를 Hashtable 로서 리턴합니다.
String	getKeyPropertyListString () 작성시로 지정한, 키의 프로퍼티의 리스트의 캐릭터 라인 표현을 리턴합니다.
int	hashCode () 이 객체명의 해시 코드를 리턴합니다.
boolean	isDomainPattern () 객체명이 도메인 부분의 패턴일지 어떨지를 체크합니다.
boolean	isPattern () 객체명이 패턴인가 어떤가를 체크합니다.
boolean	isPropertyPattern () 객체명이 키의 프로퍼티의 패턴일지 어떨지를 체크합니다.
static String	quote (String s) 지정된 String를, ObjectName에 포함하기 쉽게 인용부호로 둘러싼 값을 리턴합니다.
void	setMBeanServer (MBeanServer mbs) 쿼리가 실행되는 MBean 서버를 설정합니다.
String	toString () 객체명의 캐릭터 라인 표현을 리턴합니다.
static String	unquote (String q) 지정된 String를 인용부호로 둘러싸지 않는 형식에서 리턴합니다.

클래스 java.lang. Object 로부터 상속된 메서드

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

생성자 상세

ObjectName

public ObjectName(String  name)
           throws MalformedObjectNameException,

                  NullPointerException 

캐릭터 라인을 지정해 객체명을 작성합니다.

파라미터:

name - 객체명의 캐릭터 라인 표현

예외:

MalformedObjectNameException - 파라미터로서 건네받은 캐릭터 라인의 형식이 올바르지 않은 경우

NullPointerException - name 파라미터는 null

ObjectName

public ObjectName(String  domain,
                  String  key,
                  String  value)
           throws MalformedObjectNameException,

                  NullPointerException 

키의 프로퍼티를 1개 만 가지는 객체명을 작성합니다.

파라미터:

domain - 객체명의 도메인 부분

key - 객체명의 키의 프로퍼티에 포함되는 속성

value - 객체명의 키의 프로퍼티에 포함되는 값

예외:

MalformedObjectNameException - domain, key, 또는 value에 부정한 문자가 포함되는 경우, 또는 value가 인용부호의 사용 규칙에 따르지 않은 경우

NullPointerException - 몇개의 파라미터가 null인 경우

ObjectName

public ObjectName(String  domain,
                  Hashtable  table)
           throws MalformedObjectNameException,

                  NullPointerException 

Hashtable 로부터, 키의 프로퍼티를 복수 가지는 객체명을 작성합니다.

파라미터:

domain - 객체명의 도메인 부분

table - 키의 프로퍼티를 1개 이상 포함한 해시 테이블. 테이블내의 개개의 키의 엔트리는 객체명을 구성하는 키의 프로퍼티의 키 부분. 테이블내의 관련된 값은 객체명을 구성하는 키의 값의 부분

예외:

MalformedObjectNameException - domain에 부정한 문자가 포함되는 경우, table 내의 키 또는 값에 부정한 문자가 포함되는 경우, table 내에 인용부호의 사용 규칙에 따르지 않은 값이 있는 경우

NullPointerException - 몇개의 파라미터가 null인 경우

메서드의 상세

getInstance

public static ObjectName  getInstance(String  name)
                              throws MalformedObjectNameException,

                                     NullPointerException 

새로운 ObjectName(name) 로 취득된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다. 리턴된 객체는 ObjectName 서브 클래스의 가능성이 있습니다. 같은 파라미터를 지정해 이 메서드를 2회 호출했을 경우, 같은 객체가 리턴된 지, 2개의 동등의 (동일하지 않다) 객체가 돌려주고질 가능성이 있습니다.

파라미터:

name - 객체명의 캐릭터 라인 표현

반환값:

지정된 String에 대응하는 ObjectName

예외:

MalformedObjectNameException - 파라미터로서 건네받은 캐릭터 라인의 형식이 올바르지 않은 경우

NullPointerException - name 파라미터는 null

getInstance

public static ObjectName  getInstance(String  domain,
                                     String  key,
                                     String  value)
                              throws MalformedObjectNameException,

                                     NullPointerException 

새로운 ObjectName(domain, key, value) 로 취득된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다. 리턴된 객체는 ObjectName 서브 클래스의 가능성이 있습니다. 같은 파라미터를 지정해 이 메서드를 2회 호출했을 경우, 같은 객체가 리턴된 지, 2개의 동등의 (동일하지 않다) 객체가 돌려주고질 가능성이 있습니다.

파라미터:

domain - 객체명의 도메인 부분

key - 객체명의 키의 프로퍼티에 포함되는 속성

value - 객체명의 키의 프로퍼티에 포함되는 값

반환값:

지정된 도메인, 키, 값에 대응하는 ObjectName

예외:

MalformedObjectNameException - domain, key, 또는 value에 부정한 문자가 포함되는 경우, 또는 value가 인용부호의 사용 규칙에 따르지 않은 경우

NullPointerException - 몇개의 파라미터가 null인 경우

getInstance

public static ObjectName  getInstance(String  domain,
                                     Hashtable  table)
                              throws MalformedObjectNameException,

                                     NullPointerException 

새로운 ObjectName(domain, table) 로 취득된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다. 리턴된 객체는 ObjectName 서브 클래스의 가능성이 있습니다. 같은 파라미터를 지정해 이 메서드를 2회 호출했을 경우, 같은 객체가 리턴된 지, 2개의 동등의 (동일하지 않다) 객체가 돌려주고질 가능성이 있습니다.

파라미터:

domain - 객체명의 도메인 부분

table - 키의 프로퍼티를 1개 이상 포함한 해시 테이블. 테이블내의 개개의 키의 엔트리는 객체명을 구성하는 키의 프로퍼티의 키 부분. 테이블내의 관련된 값은 객체명을 구성하는 키의 값의 부분

반환값:

지정된 도메인 및 키 매핑에 대응하는 ObjectName

예외:

MalformedObjectNameException - domain에 부정한 문자가 포함되는 경우, table 내의 키 또는 값에 부정한 문자가 포함되는 경우, table 내에 인용부호의 사용 규칙에 따르지 않은 값이 있는 경우

NullPointerException - 몇개의 파라미터가 null인 경우

getInstance

public static ObjectName  getInstance(ObjectName  name)
                              throws NullPointerException 

지정된 객체를 사용할 수 있는 임의의 장소에서 사용 가능한 ObjectName 인스턴스를 리턴합니다. 리턴된 객체는 ObjectName 서브 클래스의 가능성이 있습니다. name가 ObjectName 서브 클래스인 경우, 같은 클래스의 객체가 리턴된다고는 할 수 없습니다.

반환값은 name와 동일하다고는 할 수 없습니다. 같은 파라미터를 지정해 이 메서드를 2회 호출했을 경우, 같은 객체가 리턴된 지, 2개의 동등의 (동일하지 않다) 객체가 돌려주고질 가능성이 있습니다.

ObjectName 은 불변이므로 ObjectName 복제의 작성에 적절하지 않은 경우도 있습니다. 이 메서드는 주로 악의를 가진 호출을 방지하기 위해서 사용됩니다. 예를 들어 중요한 코드에 예상외의 동작을 하는 서브 클래스의 인스턴스를 건네주려고 하는 호출은 회피되지 않으면 안됩니다. 중요한 코드는 이 메서드를 호출하는 것으로 올바르게 동작하는 것을 알 수 있는 ObjectName를 취득할 수 있습니다.

파라미터:

name - ObjectName 클래스의 인스턴스 또는 서브 클래스의 인스턴스

반환값:

공통의 시멘틱스를 가지는 것을 알 수 있는 ObjectName 또는 서브 클래스의 인스턴스. name가 ObjectName 시멘틱스를 존중하는 경우, name와 동등의 (다만 동일하다라고는 한정되지 않는다) 객체가 리턴된다

예외:

NullPointerException - name가 null인 경우

isPattern

public boolean isPattern()

객체명이 패턴인가 어떤가를 체크합니다. 도메인에와 일드 카드가 포함되는 경우나, 객체명이 프로퍼티 패턴의 경우, 이 객체명은 패턴입니다.

반환값:

이름이 패턴인 경우는 true, 그렇지 않은 경우는 false

isDomainPattern

public boolean isDomainPattern()

객체명이 도메인 부분의 패턴일지 어떨지를 체크합니다.

반환값:

이름이 도메인 패턴인 경우는 true, 그렇지 않은 경우는 false

isPropertyPattern

public boolean isPropertyPattern()

객체명이 키의 프로퍼티의 패턴일지 어떨지를 체크합니다.

반환값:

이름이 패턴인 경우는 true, 그렇지 않은 경우는 false

getCanonicalName

public String  getCanonicalName()

정규 형식의 이름, 즉 프로퍼티를 자구순서 (lexical order)에 늘어놓은 캐릭터 라인 표현을 리턴합니다.

정확하게는 도메인 부분, 구두점 (:), 자구순서의 키의 프로퍼티 리스트, 패턴 표시로부터 완성되는 String를 「정규 형식의 이름」이라고 부릅니다.

키의 프로퍼티의 정규 리스트는 getCanonicalKeyPropertyListString() 설명과 같은 캐릭터 라인입니다.

패턴 표시는 다음의 어느 쪽인가에 됩니다.

• ObjectName이 프로퍼티 패턴이 아닌 경우,
• ObjectName이 키를 가지지 않는 프로퍼티 패턴인 경우, asterisk
• ObjectName가 1개 이상 키를 가지는 프로퍼티 패턴인 경우, 콤마와 asterisk (,*)

반환값:

정규 형식의 이름

getDomain

public String  getDomain()

도메인 부분을 리턴합니다.

반환값:

도메인

getKeyProperty

public String  getKeyProperty(String  property)
                      throws NullPointerException 

키의 프로퍼티의 키 부분에 관련된 값을 취득합니다.

파라미터:

property - 프로퍼티. 이 프로퍼티의 값이 취득된다

반환값:

프로퍼티의 값. 이 ObjectName 내에 해당하는 프로퍼티가 없는 경우는 null

예외:

NullPointerException - property가 null인 경우

getKeyPropertyList

public Hashtable  getKeyPropertyList()

키의 프로퍼티를 Hashtable 로서 리턴합니다. 반환값은 Hashtable 입니다. 이 테이블내의 개개의 키는 ObjectName 키의 프로퍼티 리스트의 키에 일치하고 있습니다. 또, 테이블내의 값은 키에 관련된 값에 일치하고 있습니다.

반환값은 변경할 수 없습니다. 변경을 더해도, 이 ObjectName에 영향은 없습니다.

반환값:

키의 프로퍼티 테이블

getKeyPropertyListString

public String  getKeyPropertyListString()

작성시로 지정한, 키의 프로퍼티의 리스트의 캐릭터 라인 표현을 리턴합니다. 이 ObjectName가 생성자 ObjectName(String) 로 작성되었을 경우, 리턴된 String 내의 키의 프로퍼티는 생성자 인수와 지정순서로 늘어놓을 수 있습니다.

반환값:

키의 프로퍼티 리스트의 캐릭터 라인. 이 캐릭터 라인은 ObjectName가 패턴일지 어떨지에 존하지 않는다

getCanonicalKeyPropertyListString

public String  getCanonicalKeyPropertyListString()

자구순서에 늘어놓을 수 있었던 키의 프로퍼티 리스트의 캐릭터 라인 표현을 리턴합니다. 이것은 MBean를 키의 프로퍼티 리스트로부터 선택할 때의 자구 비교에 사용됩니다. 「자구순서」란 String.compareTo(String) 에 의해 나타나는 순서입니다.

반환값:

키의 프로퍼티 리스트의 정규 캐릭터 라인. 이 캐릭터 라인은 ObjectName가 패턴일지 어떨지에 존하지 않는다

toString

public String  toString()

객체명의 캐릭터 라인 표현을 리턴합니다. 이 캐릭터 라인의 형식은 지정되지 않습니다 만, 2개의 ObjectName가 동일한 경우에게만, 동일한 캐릭터 라인이 리턴됩니다 .

오버라이드(override):

클래스 Object 내의 toString

반환값:

이 객체명의 캐릭터 라인 표현

equals

public boolean equals(Object  object)

현재의 객체명과 다른 객체명을 비교합니다. 2개의 ObjectName 인스턴스는 이러한 정규 형식이 동일한 경우에게만 등가가 됩니다. 정규 형식은, getCanonicalName()에 설명된 캐릭터 라인입니다.

오버라이드(override):

클래스 Object 내의 equals

파라미터:

object - 현재의 객체명과 비교하는 객체명

반환값:

object이 ObjectName 으로 그 정규 형식이 이 ObjectName 정규 형식에 동일한 경우는 true

관련 항목:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

이 객체명의 해시 코드를 리턴합니다.

오버라이드(override):

클래스 Object 내의 hashCode

반환값:

이 객체의 해시 코드값

관련 항목:

Object.equals(java.lang.Object), Hashtable

quote

public static String  quote(String  s)
                    throws NullPointerException 

지정된 String를, ObjectName에 포함하기 쉽게 인용부호로 둘러싼 값을 리턴합니다. 반환값은 ObjectNmae 내의 키의 값으로 해서 사용할 수 있습니다. String s에는 임의의 문자를 포함할 수 있습니다 . 인용부호의 사용 방법이 적절하면, 반환값은 ObjectName 내의 정당한 값입니다.

반환값은, s 문자에 대응하는 문자의 순서를 인용부호 ("")로 둘러싼 형식이 됩니다. 반환값에 포함되는 s 내의 문자는 아래의 점으로써 변경됩니다.

• 인용부호 ("")를 backslash＋인용부호 (\")로 옮겨놓는다
• asterisk (*)를 backslash＋asterisk (\*)로 옮겨놓는다
• 물음표 (? )를 backslash＋물음표 (\? )(으)로 옮겨놓는다
• backslash 1개를 backslash 2개 로 옮겨놓는다
• 복귀 개행 문자 (Java에 있어서의 '\n')를 backslash＋ '\n'로 옮겨놓는다

파라미터:

s - 인용부호로 둘러싸이는 String

반환값:

인용부호로 둘러싸인 String

예외:

NullPointerException - s가 null인 경우

unquote

public static String  unquote(String  q)
                      throws IllegalArgumentException,

                             NullPointerException 

지정된 String를 인용부호로 둘러싸지 않는 형식에서 리턴합니다. q가 quote(s) 에 의해 리턴된 String 인 경우, unquote(q). equals(s) 입니다. quote(s). equals(q) String s가 존재하지 않는 경우, unquote(q)는 IllegalArgumentException을 Throw 합니다.

이러한 규칙은 인용부호로 둘러싸인 형식과 둘러싸이지 않은 형식이 1 대 1 으로 대응하고 있는 것을 미하고 있습니다.

파라미터:

q - 인용부호로 둘러싸이지 않는 String

반환값:

인용부호로 둘러싸이지 않은 String

예외:

IllegalArgumentException - 인용부호로 둘러싸이지 않은 경우 등, quote(java.lang.String) 메서드가 q를 돌려주지 않는 경우

NullPointerException - q가 null인 경우

apply

public boolean apply(ObjectName  name)
              throws NullPointerException 

이 ObjectName (패턴의 가능성이 있다)이 다른 ObjectName와 일치할지 어떨지를 테스트합니다. name가 패턴의 경우, 결과는 false 입니다. 이 ObjectName가 패턴으로name가 이 패턴과 일치하고 있는 경우, 결과는 true 입니다. 이 ObjectName도 name도 패턴은 아니고, 2개의 ObjectNames가 equals(Object) 메서드의 설명 대로 등가인 경우, 결과는 true 입니다.

정의:

인터페이스 QueryExp 내의 apply

파라미터:

name - 비교 대상의 MBean 이름

반환값:

name가 이 ObjectName와 일치하는 경우는 true

예외:

NullPointerException - name가 null인 경우

setMBeanServer

public void setMBeanServer(MBeanServer  mbs)

인터페이스 QueryExp 기술:

쿼리가 실행되는 MBean 서버를 설정합니다.

정의:

인터페이스 QueryExp 내의 setMBeanServer

파라미터:

mbs - 쿼리가 실행되는 MBean 서버