javax.naming.ldap
클래스 Rdn

java.lang.Object 
  javax.naming.ldap.Rdn

모든 구현된 인터페이스:

Serializable, Comparable <Object >

public class Rdn
extends Object 
implements Serializable,
 Comparable <Object >

이 클래스는 상대 식별명, 또는 식별명의 컴퍼넌트인 RDN (RFC 2253 을 참조)를 나타냅니다. 예를 들어 「OU=Sales+CN=J.Smith」라고 하는 RDN는 복수의 속성/치 페어로 구성되어 있습니다. 이 RDN는 LdapName 클래스의 설명에 기재되어 있도록 해석 대상이 됩니다.

Rdn 클래스는 RDN를, Attributes를 사용해 표시 가능한 속성의 형태와 값의 매핑으로서 표현합니다. Rdn 클래스에는 Rdn가 단일의 형/치 페어 (보통 이 형식에서 사용)로 구성되어 있을 때, 이 형태와 값을 간단하게 취득할 수 있도록 하는 편리한 메서드가 포함되어 있습니다. 또, RFC 2253에 정의되고 있는 이스케이프 구문에 따라, 서식 없음 속성값의 이스케이프와 서식화 된 값의 이스케이프 해제를 행하는 헬퍼 메서드도 포함되어 있습니다. 속성값을 Object 로서 취득, 또는 돌려주는 메서드의 경우, 값은 String (이스케이프 해제된 서식) 또는 바이트 배열이 됩니다.

Rdn는 유효한 RDN를 모두 적절히 해석하는 한편으로 무효인 RDN 해석시에는 가능한 모든 위반을 검출하지 않습니다. 즉, 무효인 RDN에 대해서 「관대」입니다. 이름의 유효성은 최종적으로 LDAP 서버에게 건네진 시점에서 판정됩니다. LDAP 서버는 schema 정보나 상호 운용의 요건등의 각종 요인에 기반해 건네받은 이름을 받아들이는지 거부합니다.

다음에 나타내는 것은 형태와 값을 인수로서 취하는 생성자를 사용해 Rdn를 구축하는 코드예입니다.

        Rdn rdn = new Rdn("cn", "Juicy, Fruit");
        System.out.println(rdn.toString());
 

맨 마지막 줄에의해 cn=Juicy\, Fruit가 출력됩니다. 원의 값 "Juicy, Fruit" 내의 이스케이프 된 콤마의 이스케이프를 해제하는데는 unescapeValue() 메서드를 사용합니다. 콤마의 전에 이스케이프를 추가하려면, escapeValue() 메서드를 사용합니다.

이 클래스는 RFC 2253에 정의되고 있는 RDN 캐릭터 라인 표현에의해 인스턴스화 됩니다. 다음의 코드예를 참조하십시오.

        Rdn rdn = new Rdn("cn=Juicy\\, Fruit");
        System.out.println(rdn.toString());
 

맨 마지막 줄에의해 cn=Juicy\, Fruit가 출력됩니다.

Rdn 인스턴스에 대한 읽기 전용 의 병렬 multi-thread 액세스는 반드시 동기 시키지 않아도 괜찮습니다.

외로 지정이 없는 경우, null 인수를 생성자, 또는 이 클래스의 메서드에 건네주면, NullPointerException가 발생 됩니다.

도입된 버전 :

1.5

관련 항목:

직렬화 된 형식

생성자 개요

Rdn (Attributes attrSet)
지정의 속성 세트로부터 Rdn를 작성합니다.

Rdn (Rdn rdn)
지정의 rdn로 부터 Rdn를 작성합니다.

Rdn (String rdnString)
지정의 캐릭터 라인으로부터 Rdn를 작성합니다.

Rdn (String type, Object value)
지정의 속성의 형태 및 값으로부터 Rdn를 작성합니다.

메서드 개요

int	compareTo (Object obj) Rdn와 지정된 Object 순서를 비교합니다.
boolean	equals (Object obj) 지정의 Object 곳의 Rdn 동등성을 비교합니다.
static String	escapeValue (Object val) 속성의 값을 지정해, RFC 2253 으로 가리키는 규칙에 따라 이스케이프 된 캐릭터 라인을 리턴합니다.
String	getType () 이 Rdn 형태의 1개를 취득합니다.
Object	getValue () 이 Rdn 값의 1개를 취득합니다.
int	hashCode () 이 RDN 해시 코드를 리턴합니다.
int	size () 이 Rdn에 포함되는 속성의 형/치 페어의 수를 취득합니다.
Attributes	toAttributes () 이 Rdn에 포함되는 형/치의 매핑 Attributes 뷰를 취득합니다.
String	toString () RFC 2253에 정의되어LdapName 클래스의 설명에 기재되어 있는 서식에서 표현된 캐릭터 라인으로서 이 Rdn를 리턴합니다.
static Object	unescapeValue (String val) RFC 2253 으로 가리키는 규칙에 따라 서식화 된 속성값의 캐릭터 라인을 지정해, 서식화되어 있지 않은 값을 리턴합니다.

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

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

생성자 상세

Rdn

public Rdn(Attributes  attrSet)
    throws InvalidNameException 

지정의 속성 세트로부터 Rdn를 작성합니다. Attributes를 참조하십시오.

캐릭터 라인의 속성값는 RFC 2253 지정의 서식의 RDN 캐릭터 라인과는 해석되지 않습니다. 즉, 이러한 값은 문자 대로 해석되고 (해석의 대상이 되지 않는다), 이스케이프는 해제되고 있는 것이라고 보여집니다.

파라미터:

attrSet - 형/치의 매핑을 포함한 null 이외의 비어있지 않은 속성

예외:

InvalidNameException - attrSet 내용을 사용해 유효한 RDN를 작성할 수 없는 경우

Rdn

public Rdn(String  rdnString)
    throws InvalidNameException 

지정의 캐릭터 라인으로부터 Rdn를 작성합니다. 이 생성자는 RFC 2253에 정의되고 있는 규칙에 따라 서식화 된 캐릭터 라인을 취합니다. 이 규칙에 대해서는 LdapName 클래스의 설명을 참조하십시오.

파라미터:

rdnString - RFC 2253에 정의되고 있는 서식을 가지는 null 이외의 비어있지 않은 캐릭터 라인

예외:

InvalidNameException - rdnString 해석시에 구문 에러가 발생했을 경우

Rdn

public Rdn(Rdn  rdn)

지정의 rdn로 부터 Rdn를 작성합니다. rdn 내용은 새롭게 작성된 Rdn에 단순하게 복사됩니다.

파라미터:

rdn - 카피하는 null 이외의 Rdn

Rdn

public Rdn(String  type,
           Object  value)
    throws InvalidNameException 

지정의 속성의 형태 및 값으로부터 Rdn를 작성합니다. 캐릭터 라인의 속성값는 RFC 2253 지정의 서식의 RDN 캐릭터 라인과는 해석되지 않습니다. 즉, 이러한 값은 문자 대로 해석되고 (해석의 대상이 되지 않는다), 이스케이프는 해제되고 있는 것이라고 보여집니다.

파라미터:

type - null 이외의 비어있지 않은 캐릭터 라인의 속성의 형태

value - null 이외의 비어있지 않은 캐릭터 라인의 속성의 값

예외:

InvalidNameException - 형/치의 페어를 사용해 유효한 RDN를 작성할 수 없는 경우

관련 항목:

toString()

메서드의 상세

getValue

public Object  getValue()

이 Rdn 값의 1개를 취득합니다. 이것은 RDN에 형태와 값의 매핑이 1개 만 포함될 때 (일반적인 RDN 사용예), 이 값을 취득하기 위해서 사용하는 편리한 메서드입니다.

RDN 값이 복수 존재하는 경우, 이 메서드는 getType() 메서드에 의해 리턴된 형태에 대응하는 값을 리턴합니다.

반환값:

null 이외의 속성값

getType

public String  getType()

이 Rdn 형태의 1개를 취득합니다. 이것은 RDN에 형태와 값의 매핑이 1개 만 포함될 때 (일반적인 RDN 사용예), 이 형태를 취득하기 위해서 사용하는 편리한 메서드입니다.

RDN 값이 복수 존재하는 경우, 형/치 페어의 순서는 특히 정의되지 않습니다. 이 경우 이 메서드는 형/치 페어의 어느쪽이든 1개의 형태를 리턴합니다. getValue() 메서드는 이 메서드에 의해 리턴된 형태에 대응하는 값을 리턴합니다.

반환값:

null 이외의 속성형

toString

public String  toString()

RFC 2253에 정의되어LdapName 클래스의 설명에 기재되어 있는 서식에서 표현된 캐릭터 라인으로서 이 Rdn를 리턴합니다.

오버라이드(override):

클래스 Object 내의 toString

반환값:

Rdn 캐릭터 라인 표현

compareTo

public int compareTo(Object  obj)

Rdn와 지정된 Object 순서를 비교합니다. Rdn가 지정된 Object 보다 작은 경우는 부의 정수, 동일한 경우는 0, 큰 경우는 정의 정수를 각각 리턴합니다.

obj가 null, 또는 Rdn 인스턴스가 아닌 경우는 ClassCastException가 발생 됩니다.

RDN 속성의 형태와 값의 페어가 각각 사전적으로 비교됩니다. 복수의 값을 가지는 Rdn ( 「ou=Sales+cn=Bob」등)를 구성하는 컴퍼넌트의 순서는 중요하지는 않습니다.

정의:

인터페이스 Comparable <Object > 내의 compareTo

파라미터:

obj - 비교되는 null 이외의 객체

반환값:

이 Rdn가 지정된 Object 보다 작은 경우는 부의 정수, 동일한 경우는 0, 큰 경우는 정의 정수

예외:

ClassCastException - obj가 null 인지, Rdn가 아닌 경우

equals

public boolean equals(Object  obj)

지정의 Object 곳의 Rdn 동등성을 비교합니다. 비교 대조의 객체도 Rdn 이며, 2개의 Rdn가 동일한 속성의 형태와 값의 매핑을 나타내고 있는 경우는 true가 리턴됩니다 . 복수의 값을 가지는 Rdn ( 「ou=Sales+cn=Bob」 등) 내의 컴퍼넌트의 순서는 중요하지는 않습니다.

형태의 값의 동등성의 매칭은 다음과 같이 행해집니다.

• 형태의 동등성이 비교된다 (알파벳의 대문자와 소문자는 구별되지 않는다)
• 캐릭터 라인의 값자체가 차이가 나도, 인용, 이스케이프, UTF-8 16 진인코딩등이 동일하면 동등이라고 보여진다 (값의 알파벳의 대문자와 소문자는 구별되지 않는다)

obj가 null 인 경우, 또는 Rdn 인스턴스가 아닌 경우는 false가 리턴됩니다 .

오버라이드(override):

클래스 Object 내의 equals

파라미터:

obj - 이 Rdn와 동일한지 어떤지를 비교하는 객체

반환값:

지정된 객체가 이 Rdn와 동일한 경우는 true

관련 항목:

hashCode()

hashCode

public int hashCode()

이 RDN 해시 코드를 리턴합니다. equals 메서드에 의해 동등하다라고 하는 것이 알고 있는 2개의 RDN는 같은 해시 코드를 가집니다.

오버라이드(override):

클래스 Object 내의 hashCode

반환값:

이 Rdn 해시 코드를 나타내는 int

관련 항목:

equals(java.lang.Object)

toAttributes

public Attributes  toAttributes()

이 Rdn에 포함되는 형/치의 매핑 Attributes 뷰를 취득합니다.

반환값:

이 Rdn 형/치의 매핑을 포함한, null 이외의 속성

size

public int size()

이 Rdn에 포함되는 속성의 형/치 페어의 수를 취득합니다.

반환값:

이 Rdn에 포함되는 형/치 페어의 수 (0 이상)

escapeValue

public static String  escapeValue(Object  val)

속성의 값을 지정해, RFC 2253 으로 가리키는 규칙에 따라 이스케이프 된 캐릭터 라인을 리턴합니다.

예를 들어 val가 「Sue, Grabbit and Runn」의 경우, 이 메서드에 의해 리턴된 이스케이프 된 값은 「Sue\, Grabbit and Runn」가 됩니다.

캐릭터 라인치는 String와 바이트 배열로 나타내지는 바이너리값으로 표현됩니다.

파라미터:

val - 이스케이프 하는 null 이외의 객체

반환값:

이스케이프 된 캐릭터 라인치

예외:

ClassCastException - val가 String 에서도 바이트 배열도 아닌 경우

unescapeValue

public static Object  unescapeValue(String  val)

RFC 2253 으로 가리키는 규칙에 따라 서식화 된 속성값의 캐릭터 라인을 지정해, 서식화되어 있지 않은 값을 리턴합니다. 이스케이프와 인용부호는 제거되어 16 진인코딩 된 UTF-8는 동등의 UTF-16 문자에 변환됩니다. 캐릭터 라인치를 String, 바이너리치를 바이트 배열로서 리턴합니다.

정당한 값과 부당한 값은 RFC 2253에 정의되고 있습니다. 이 메서드는 값을 받아들이는 것에 대해 관대해, 부당한 값을 모두 검출하지 않습니다. 따라서, 부당한 값을 건네주어도, 반드시 IllegalArgumentException는 트리거 되지 않습니다.

파라미터:

val - 이스케이프 해제하는 null 이외의 캐릭터 라인

반환값:

이스케이프 해제된 값

예외:

IllegalArgumentException - 부당한 값이 건네받았을 경우